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

package/types/services/messaging.d.ts

@@ -1,18 +1,20 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { MessageType } from '../enums/message-type';
+import { SMTPEncryption } from '../enums/s-m-t-p-encryption';
 export declare class Messaging extends Service {
     constructor(client: Client);
     /**
      * List messages
      *
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listMessages(queries?: string, search?: string): Promise<Models.MessageList>;
+    listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
     /**
      * Create an email.
      *
@@ -25,14 +27,13 @@ export declare class Messaging extends Service {
      * @param {string[]} targets
      * @param {string[]} cc
      * @param {string[]} bcc
-     * @param {string} description
-     * @param {string} status
+     * @param {MessageType} status
      * @param {boolean} html
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], description?: string, status?: string, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
+    createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], status?: MessageType, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Update an email.
      *
@@ -42,9 +43,8 @@ export declare class Messaging extends Service {
      * @param {string[]} users
      * @param {string[]} targets
      * @param {string} subject
-     * @param {string} description
      * @param {string} content
-     * @param {string} status
+     * @param {MessageType} status
      * @param {boolean} html
      * @param {string[]} cc
      * @param {string[]} bcc
@@ -52,7 +52,7 @@ export declare class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, description?: string, content?: string, status?: string, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
+    updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, status?: MessageType, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
     /**
      * Create a push notification.
      *
@@ -63,7 +63,6 @@ export declare class Messaging extends Service {
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
      * @param {object} data
      * @param {string} action
      * @param {string} icon
@@ -71,12 +70,12 @@ export declare class Messaging extends Service {
      * @param {string} color
      * @param {string} tag
      * @param {string} badge
-     * @param {string} status
+     * @param {MessageType} status
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createPush(messageId: string, title: string, body: string, topics?: string[], users?: string[], targets?: string[], description?: string, data?: object, action?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, status?: string, scheduledAt?: string): Promise<Models.Message>;
+    createPush(messageId: string, title: string, body: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, status?: MessageType, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Update a push notification.
      *
@@ -85,7 +84,6 @@ export declare class Messaging extends Service {
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
      * @param {string} title
      * @param {string} body
      * @param {object} data
@@ -95,12 +93,12 @@ export declare class Messaging extends Service {
      * @param {string} color
      * @param {string} tag
      * @param {number} badge
-     * @param {string} status
+     * @param {MessageType} status
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updatePushNotification(messageId: string, topics?: string[], users?: string[], targets?: string[], description?: string, title?: string, body?: string, data?: object, action?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, status?: string, scheduledAt?: string): Promise<Models.Message>;
+    updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, status?: MessageType, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Create an SMS.
      *
@@ -110,13 +108,12 @@ export declare class Messaging extends Service {
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
-     * @param {string} status
+     * @param {MessageType} status
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSMS(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], description?: string, status?: string, scheduledAt?: string): Promise<Models.Message>;
+    createSMS(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], status?: MessageType, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Update an SMS.
      *
@@ -125,14 +122,13 @@ export declare class Messaging extends Service {
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
      * @param {string} content
-     * @param {string} status
+     * @param {MessageType} status
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSMS(messageId: string, topics?: string[], users?: string[], targets?: string[], description?: string, content?: string, status?: string, scheduledAt?: string): Promise<Models.Message>;
+    updateSMS(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, status?: MessageType, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Get a message
      *
@@ -142,6 +138,15 @@ export declare class Messaging extends Service {
      * @returns {Promise}
     */
     getMessage(messageId: string): Promise<Models.Message>;
+    /**
+     * Delete a message
+     *
+     *
+     * @param {string} messageId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    delete(messageId: string): Promise<{}>;
     /**
      * List message logs
      *
@@ -159,21 +164,21 @@ export declare class Messaging extends Service {
      * attribute.
      *
      * @param {string} messageId
-     * @param {string} queries
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listTargets(messageId: string, queries?: string): Promise<Models.TargetList>;
+    listTargets(messageId: string, queries?: string[]): Promise<Models.TargetList>;
     /**
      * List providers
      *
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listProviders(queries?: string, search?: string): Promise<Models.ProviderList>;
+    listProviders(queries?: string[], search?: string): Promise<Models.ProviderList>;
     /**
      * Create APNS provider
      *
@@ -237,15 +242,15 @@ export declare class Messaging extends Service {
      * @param {string} apiKey
      * @param {string} domain
      * @param {boolean} isEuRegion
-     * @param {boolean} enabled
      * @param {string} fromName
      * @param {string} fromEmail
      * @param {string} replyToName
      * @param {string} replyToEmail
+     * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createMailgunProvider(providerId: string, name: string, apiKey?: string, domain?: string, isEuRegion?: boolean, enabled?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
+    createMailgunProvider(providerId: string, name: string, apiKey?: string, domain?: string, isEuRegion?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update Mailgun provider
      *
@@ -299,15 +304,15 @@ export declare class Messaging extends Service {
      * @param {string} providerId
      * @param {string} name
      * @param {string} apiKey
-     * @param {boolean} enabled
      * @param {string} fromName
      * @param {string} fromEmail
      * @param {string} replyToName
      * @param {string} replyToEmail
+     * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSendgridProvider(providerId: string, name: string, apiKey?: string, enabled?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
+    createSendgridProvider(providerId: string, name: string, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update Sendgrid provider
      *
@@ -324,6 +329,49 @@ export declare class Messaging extends Service {
      * @returns {Promise}
     */
     updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
+    /**
+     * Create SMTP provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} host
+     * @param {number} port
+     * @param {string} username
+     * @param {string} password
+     * @param {SMTPEncryption} encryption
+     * @param {boolean} autoTLS
+     * @param {string} mailer
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSMTPProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SMTPEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update SMTP provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} host
+     * @param {number} port
+     * @param {string} username
+     * @param {string} password
+     * @param {SMTPEncryption} encryption
+     * @param {boolean} autoTLS
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateSMTPProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SMTPEncryption, autoTLS?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Create Telesign provider
      *
@@ -478,23 +526,22 @@ export declare class Messaging extends Service {
      * List topics.
      *
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listTopics(queries?: string, search?: string): Promise<Models.TopicList>;
+    listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
     /**
      * Create a topic.
      *
      *
      * @param {string} topicId
      * @param {string} name
-     * @param {string} description
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createTopic(topicId: string, name: string, description?: string): Promise<Models.Topic>;
+    createTopic(topicId: string, name: string): Promise<Models.Topic>;
     /**
      * Get a topic.
      *
@@ -510,11 +557,10 @@ export declare class Messaging extends Service {
      *
      * @param {string} topicId
      * @param {string} name
-     * @param {string} description
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateTopic(topicId: string, name?: string, description?: string): Promise<Models.Topic>;
+    updateTopic(topicId: string, name?: string): Promise<Models.Topic>;
     /**
      * Delete a topic.
      *
@@ -539,12 +585,12 @@ export declare class Messaging extends Service {
      *
      *
      * @param {string} topicId
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listSubscribers(topicId: string, queries?: string, search?: string): Promise<Models.SubscriberList>;
+    listSubscribers(topicId: string, queries?: string[], search?: string): Promise<Models.SubscriberList>;
     /**
      * Create a subscriber.
      *

package/types/services/migrations.d.ts

@@ -7,12 +7,12 @@ export declare class Migrations extends Service {
      * List Migrations
      *
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    list(queries?: string, search?: string): Promise<Models.MigrationList>;
+    list(queries?: string[], search?: string): Promise<Models.MigrationList>;
     /**
      * Migrate Appwrite Data
      *

package/types/services/project.d.ts

@@ -1,6 +1,7 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { ProjectUsageRange } from '../enums/project-usage-range';
 export declare class Project extends Service {
     constructor(client: Client);
     /**
@@ -9,11 +10,11 @@ export declare class Project extends Service {
      *
      * @param {string} startDate
      * @param {string} endDate
-     * @param {string} period
+     * @param {ProjectUsageRange} period
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(startDate: string, endDate: string, period?: string): Promise<Models.UsageProject>;
+    getUsage(startDate: string, endDate: string, period?: ProjectUsageRange): Promise<Models.UsageProject>;
     /**
      * List Variables
      *

package/types/services/projects.d.ts

@@ -1,6 +1,14 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Region } from '../enums/region';
+import { AuthMethod } from '../enums/auth-method';
+import { OAuthProvider } from '../enums/o-auth-provider';
+import { PlatformType } from '../enums/platform-type';
+import { APIService } from '../enums/a-p-i-service';
+import { SMTPSecure } from '../enums/s-m-t-p-secure';
+import { TemplateType } from '../enums/template-type';
+import { TemplateLocale } from '../enums/template-locale';
 export declare class Projects extends Service {
     constructor(client: Client);
     /**
@@ -20,7 +28,7 @@ export declare class Projects extends Service {
      * @param {string} projectId
      * @param {string} name
      * @param {string} teamId
-     * @param {string} region
+     * @param {Region} region
      * @param {string} description
      * @param {string} logo
      * @param {string} url
@@ -33,7 +41,7 @@ export declare class Projects extends Service {
      * @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>;
+    create(projectId: string, name: string, teamId: string, region?: Region, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
     /**
      * Get project
      *
@@ -101,16 +109,6 @@ export declare class Projects extends Service {
      * @returns {Promise}
     */
     updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
-    /**
-     * Update Project user minimum sessions factors
-     *
-     *
-     * @param {string} projectId
-     * @param {number} factors
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    updateAuthMfaFactors(projectId: string, factors: number): Promise<Models.Project>;
     /**
      * Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password
      *
@@ -146,12 +144,12 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} method
+     * @param {AuthMethod} method
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateAuthStatus(projectId: string, method: string, status: boolean): Promise<Models.Project>;
+    updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
     /**
      * List keys
      *
@@ -211,14 +209,14 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} provider
+     * @param {OAuthProvider} provider
      * @param {string} appId
      * @param {string} secret
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateOAuth2(projectId: string, provider: string, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
+    updateOAuth2(projectId: string, provider: OAuthProvider, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
     /**
      * List platforms
      *
@@ -233,7 +231,7 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} type
+     * @param {PlatformType} type
      * @param {string} name
      * @param {string} key
      * @param {string} store
@@ -241,7 +239,7 @@ export declare class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createPlatform(projectId: string, type: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
+    createPlatform(projectId: string, type: PlatformType, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
      * Get platform
      *
@@ -281,12 +279,12 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} service
+     * @param {APIService} service
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateServiceStatus(projectId: string, service: string, status: boolean): Promise<Models.Project>;
+    updateServiceStatus(projectId: string, service: APIService, status: boolean): Promise<Models.Project>;
     /**
      * Update all service status
      *
@@ -310,11 +308,11 @@ export declare class Projects extends Service {
      * @param {number} port
      * @param {string} username
      * @param {string} password
-     * @param {string} secure
+     * @param {SMTPSecure} secure
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: string): Promise<Models.Project>;
+    updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
     /**
      * Create SMTP test
      *
@@ -328,11 +326,11 @@ export declare class Projects extends Service {
      * @param {number} port
      * @param {string} username
      * @param {string} password
-     * @param {string} secure
+     * @param {SMTPSecure} secure
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: string): Promise<{}>;
+    createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
     /**
      * Update Project Team
      *
@@ -348,19 +346,19 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {TemplateType} type
+     * @param {TemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getEmailTemplate(projectId: string, type: string, locale: string): Promise<Models.EmailTemplate>;
+    getEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.EmailTemplate>;
     /**
      * Update custom email templates
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {TemplateType} type
+     * @param {TemplateLocale} locale
      * @param {string} subject
      * @param {string} message
      * @param {string} senderName
@@ -369,52 +367,52 @@ export declare class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateEmailTemplate(projectId: string, type: string, locale: string, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project>;
+    updateEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale, 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
+     * @param {TemplateType} type
+     * @param {TemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteEmailTemplate(projectId: string, type: string, locale: string): Promise<Models.EmailTemplate>;
+    deleteEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.EmailTemplate>;
     /**
      * Get custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {TemplateType} type
+     * @param {TemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getSmsTemplate(projectId: string, type: string, locale: string): Promise<Models.SmsTemplate>;
+    getSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.SmsTemplate>;
     /**
      * Update custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {TemplateType} type
+     * @param {TemplateLocale} locale
      * @param {string} message
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSmsTemplate(projectId: string, type: string, locale: string, message: string): Promise<Models.SmsTemplate>;
+    updateSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale, message: string): Promise<Models.SmsTemplate>;
     /**
      * Reset custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {TemplateType} type
+     * @param {TemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteSmsTemplate(projectId: string, type: string, locale: string): Promise<Models.SmsTemplate>;
+    deleteSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.SmsTemplate>;
     /**
      * List webhooks
      *

package/types/services/proxy.d.ts

@@ -1,6 +1,7 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { ResourceType } from '../enums/resource-type';
 export declare class Proxy extends Service {
     constructor(client: Client);
     /**
@@ -21,12 +22,12 @@ export declare class Proxy extends Service {
      * Create a new proxy rule.
      *
      * @param {string} domain
-     * @param {string} resourceType
+     * @param {ResourceType} resourceType
      * @param {string} resourceId
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createRule(domain: string, resourceType: string, resourceId?: string): Promise<Models.ProxyRule>;
+    createRule(domain: string, resourceType: ResourceType, resourceId?: string): Promise<Models.ProxyRule>;
     /**
      * Get Rule
      *