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

package/types/services/messaging.d.ts

@@ -1,18 +1,20 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { MessageStatus } from '../enums/message-status';
+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.
      *
@@ -23,14 +25,15 @@ export declare class Messaging extends Service {
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
-     * @param {string} status
+     * @param {string[]} cc
+     * @param {string[]} bcc
+     * @param {MessageStatus} status
      * @param {boolean} html
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createEmailMessage(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: 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?: MessageStatus, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Update an email.
      *
@@ -40,15 +43,16 @@ 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 {MessageStatus} status
      * @param {boolean} html
+     * @param {string[]} cc
+     * @param {string[]} bcc
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, description?: string, content?: string, status?: string, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
+    updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, status?: MessageStatus, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
     /**
      * Create a push notification.
      *
@@ -59,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
@@ -67,12 +70,12 @@ export declare class Messaging extends Service {
      * @param {string} color
      * @param {string} tag
      * @param {string} badge
-     * @param {string} status
+     * @param {MessageStatus} status
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createPushMessage(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?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Update a push notification.
      *
@@ -81,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
@@ -90,13 +92,13 @@ export declare class Messaging extends Service {
      * @param {string} sound
      * @param {string} color
      * @param {string} tag
-     * @param {string} badge
-     * @param {string} status
+     * @param {number} badge
+     * @param {MessageStatus} 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?: string, 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?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Create an SMS.
      *
@@ -106,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 {MessageStatus} status
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSMSMessage(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?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Update an SMS.
      *
@@ -121,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 {MessageStatus} 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?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Get a message
      *
@@ -138,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
      *
@@ -148,16 +157,28 @@ export declare class Messaging extends Service {
      * @returns {Promise}
     */
     listMessageLogs(messageId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * List message targets
+     *
+     * List the targets associated with a message as set via the targets
+     * attribute.
+     *
+     * @param {string} messageId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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
      *
@@ -168,12 +189,11 @@ export declare class Messaging extends Service {
      * @param {string} authKeyId
      * @param {string} teamId
      * @param {string} bundleId
-     * @param {string} endpoint
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, endpoint?: string, enabled?: boolean): Promise<Models.Provider>;
+    createAPNSProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update APNS provider
      *
@@ -185,23 +205,22 @@ export declare class Messaging extends Service {
      * @param {string} authKeyId
      * @param {string} teamId
      * @param {string} bundleId
-     * @param {string} endpoint
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateApnsProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, endpoint?: string): Promise<Models.Provider>;
+    updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string): Promise<Models.Provider>;
     /**
      * Create FCM provider
      *
      *
      * @param {string} providerId
      * @param {string} name
-     * @param {string} serverKey
+     * @param {object} serviceAccountJSON
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createFcmProvider(providerId: string, name: string, serverKey?: string, enabled?: boolean): Promise<Models.Provider>;
+    createFCMProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update FCM provider
      *
@@ -209,41 +228,47 @@ export declare class Messaging extends Service {
      * @param {string} providerId
      * @param {string} name
      * @param {boolean} enabled
-     * @param {string} serverKey
+     * @param {object} serviceAccountJSON
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serverKey?: string): Promise<Models.Provider>;
+    updateFCMProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
     /**
      * Create Mailgun provider
      *
      *
      * @param {string} providerId
      * @param {string} name
-     * @param {string} from
      * @param {string} apiKey
      * @param {string} domain
      * @param {boolean} isEuRegion
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createMailgunProvider(providerId: string, name: string, from?: string, apiKey?: string, domain?: string, isEuRegion?: boolean, enabled?: boolean): 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
      *
      *
      * @param {string} providerId
      * @param {string} name
-     * @param {boolean} enabled
-     * @param {boolean} isEuRegion
-     * @param {string} from
      * @param {string} apiKey
      * @param {string} domain
+     * @param {boolean} isEuRegion
+     * @param {boolean} enabled
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateMailgunProvider(providerId: string, name?: string, enabled?: boolean, isEuRegion?: boolean, from?: string, apiKey?: string, domain?: string): Promise<Models.Provider>;
+    updateMailgunProvider(providerId: string, name?: string, apiKey?: string, domain?: string, isEuRegion?: boolean, enabled?: boolean, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
     /**
      * Create Msg91 provider
      *
@@ -278,13 +303,16 @@ export declare class Messaging extends Service {
      *
      * @param {string} providerId
      * @param {string} name
-     * @param {string} from
      * @param {string} apiKey
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSendgridProvider(providerId: string, name: string, from?: string, apiKey?: string, enabled?: boolean): 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
      *
@@ -293,39 +321,86 @@ export declare class Messaging extends Service {
      * @param {string} name
      * @param {boolean} enabled
      * @param {string} apiKey
-     * @param {string} from
+     * @param {string} fromName
+     * @param {string} fromEmail
+     * @param {string} replyToName
+     * @param {string} replyToEmail
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, from?: string): Promise<Models.Provider>;
+    updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
     /**
-     * Create Telesign provider
+     * Create SMTP provider
      *
      *
      * @param {string} providerId
      * @param {string} name
-     * @param {string} from
+     * @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}
     */
-    createTelesignProvider(providerId: string, name: string, from?: string, username?: string, password?: string, enabled?: boolean): Promise<Models.Provider>;
+    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 Telesign provider
+     * Update SMTP provider
      *
      *
      * @param {string} providerId
      * @param {string} name
-     * @param {boolean} enabled
+     * @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}
+    */
+    updateSMTPProvider(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>;
+    /**
+     * Create Telesign provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {string} from
+     * @param {string} customerId
+     * @param {string} apiKey
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createTelesignProvider(providerId: string, name: string, from?: string, customerId?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
+    /**
+     * Update Telesign provider
+     *
+     *
+     * @param {string} providerId
+     * @param {string} name
+     * @param {boolean} enabled
+     * @param {string} customerId
+     * @param {string} apiKey
      * @param {string} from
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateTelesignProvider(providerId: string, name?: string, enabled?: boolean, username?: string, password?: string, from?: string): Promise<Models.Provider>;
+    updateTelesignProvider(providerId: string, name?: string, enabled?: boolean, customerId?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
     /**
      * Create Textmagic provider
      *
@@ -452,23 +527,23 @@ 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
+     * @param {string[]} subscribe
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createTopic(topicId: string, name: string, description?: string): Promise<Models.Topic>;
+    createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
      * Get a topic.
      *
@@ -484,11 +559,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.
      *
@@ -513,12 +587,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,17 +1,20 @@
 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);
     /**
      * Get usage stats for a project
      *
      *
-     * @param {string} range
+     * @param {string} startDate
+     * @param {string} endDate
+     * @param {ProjectUsageRange} period
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string): Promise<Models.UsageProject>;
+    getUsage(startDate: string, endDate: string, period?: ProjectUsageRange): Promise<Models.UsageProject>;
     /**
      * List Variables
      *