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

package/types/services/messaging.d.ts

@@ -1,21 +1,24 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { SmtpEncryption } from '../enums/smtp-encryption';
 export declare class Messaging extends Service {
     constructor(client: Client);
     /**
      * List messages
      *
+     * Get a list of all messages from the current Appwrite project.
      *
-     * @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.
+     * Create email
      *
+     * Create a new email message.
      *
      * @param {string} messageId
      * @param {string} subject
@@ -25,16 +28,18 @@ export declare class Messaging extends Service {
      * @param {string[]} targets
      * @param {string[]} cc
      * @param {string[]} bcc
-     * @param {string} description
-     * @param {string} status
+     * @param {string[]} attachments
+     * @param {boolean} draft
      * @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[], attachments?: string[], draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Update an email.
+     * Update email
+     *
+     * Update an email message by its unique ID.
      *
      *
      * @param {string} messageId
@@ -42,9 +47,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 {boolean} draft
      * @param {boolean} html
      * @param {string[]} cc
      * @param {string[]} bcc
@@ -52,10 +56,11 @@ 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, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Create a push notification.
+     * Create push notification
      *
+     * Create a new push notification.
      *
      * @param {string} messageId
      * @param {string} title
@@ -63,78 +68,83 @@ 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} image
      * @param {string} icon
      * @param {string} sound
      * @param {string} color
      * @param {string} tag
      * @param {string} badge
-     * @param {string} status
+     * @param {boolean} draft
      * @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, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Update a push notification.
+     * Update push notification
+     *
+     * Update a push notification by its unique ID.
      *
      *
      * @param {string} messageId
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
      * @param {string} title
      * @param {string} body
      * @param {object} data
      * @param {string} action
+     * @param {string} image
      * @param {string} icon
      * @param {string} sound
      * @param {string} color
      * @param {string} tag
      * @param {number} badge
-     * @param {string} status
+     * @param {boolean} draft
      * @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, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Create an SMS.
+     * Create SMS
      *
+     * Create a new SMS message.
      *
      * @param {string} messageId
      * @param {string} content
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
-     * @param {string} status
+     * @param {boolean} draft
      * @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[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Update an SMS.
+     * Update SMS
+     *
+     * Update an email message by its unique ID.
      *
      *
      * @param {string} messageId
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {string} description
      * @param {string} content
-     * @param {string} status
+     * @param {boolean} draft
      * @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, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
-     * Get a message
+     * Get message
+     *
+     * Get a message by its unique ID.
      *
      *
      * @param {string} messageId
@@ -142,9 +152,21 @@ export declare class Messaging extends Service {
      * @returns {Promise}
     */
     getMessage(messageId: string): Promise<Models.Message>;
+    /**
+     * Delete message
+     *
+     * Delete a message. If the message is not a draft or scheduled, but has been
+     * sent, this will not recall the message.
+     *
+     * @param {string} messageId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    delete(messageId: string): Promise<{}>;
     /**
      * List message logs
      *
+     * Get the message activity logs listed by its unique ID.
      *
      * @param {string} messageId
      * @param {string[]} queries
@@ -155,28 +177,29 @@ export declare class Messaging extends Service {
     /**
      * List message targets
      *
-     * List the targets associated with a message as set via the targets
-     * attribute.
+     * Get a list of the targets associated with a message.
      *
      * @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
      *
+     * Get a list of all providers from the current Appwrite project.
      *
-     * @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
      *
+     * Create a new Apple Push Notification service provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -184,14 +207,16 @@ export declare class Messaging extends Service {
      * @param {string} authKeyId
      * @param {string} teamId
      * @param {string} bundleId
+     * @param {boolean} sandbox
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createAPNSProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, enabled?: boolean): Promise<Models.Provider>;
+    createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update APNS provider
      *
+     * Update a Apple Push Notification service provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -200,13 +225,15 @@ export declare class Messaging extends Service {
      * @param {string} authKeyId
      * @param {string} teamId
      * @param {string} bundleId
+     * @param {boolean} sandbox
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string): Promise<Models.Provider>;
+    updateApnsProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
     /**
      * Create FCM provider
      *
+     * Create a new Firebase Cloud Messaging provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -215,10 +242,11 @@ export declare class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createFCMProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
+    createFcmProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update FCM provider
      *
+     * Update a Firebase Cloud Messaging provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -227,28 +255,30 @@ export declare class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateFCMProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
+    updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
     /**
      * Create Mailgun provider
      *
+     * Create a new Mailgun provider.
      *
      * @param {string} providerId
      * @param {string} name
      * @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
      *
+     * Update a Mailgun provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -267,6 +297,7 @@ export declare class Messaging extends Service {
     /**
      * Create Msg91 provider
      *
+     * Create a new MSG91 provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -281,6 +312,7 @@ export declare class Messaging extends Service {
     /**
      * Update Msg91 provider
      *
+     * Update a MSG91 provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -295,22 +327,24 @@ export declare class Messaging extends Service {
     /**
      * Create Sendgrid provider
      *
+     * Create a new Sendgrid provider.
      *
      * @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
      *
+     * Update a Sendgrid provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -325,36 +359,85 @@ export declare class Messaging extends Service {
     */
     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
      *
+     * Create a new 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
      *
+     * Update a SMTP provider by its unique ID.
      *
      * @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
+     *
+     * Create a new 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
+     *
+     * Update a Telesign provider by its unique ID.
+     *
+     * @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
      *
+     * Create a new Textmagic provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -369,6 +452,7 @@ export declare class Messaging extends Service {
     /**
      * Update Textmagic provider
      *
+     * Update a Textmagic provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -383,6 +467,7 @@ export declare class Messaging extends Service {
     /**
      * Create Twilio provider
      *
+     * Create a new Twilio provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -397,6 +482,7 @@ export declare class Messaging extends Service {
     /**
      * Update Twilio provider
      *
+     * Update a Twilio provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -411,6 +497,7 @@ export declare class Messaging extends Service {
     /**
      * Create Vonage provider
      *
+     * Create a new Vonage provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -425,6 +512,7 @@ export declare class Messaging extends Service {
     /**
      * Update Vonage provider
      *
+     * Update a Vonage provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -439,6 +527,8 @@ export declare class Messaging extends Service {
     /**
      * Get provider
      *
+     * Get a provider by its unique ID.
+     *
      *
      * @param {string} providerId
      * @throws {AppwriteException}
@@ -448,6 +538,7 @@ export declare class Messaging extends Service {
     /**
      * Delete provider
      *
+     * Delete a provider by its unique ID.
      *
      * @param {string} providerId
      * @throws {AppwriteException}
@@ -457,6 +548,7 @@ export declare class Messaging extends Service {
     /**
      * List provider logs
      *
+     * Get the provider activity logs listed by its unique ID.
      *
      * @param {string} providerId
      * @param {string[]} queries
@@ -467,6 +559,7 @@ export declare class Messaging extends Service {
     /**
      * List subscriber logs
      *
+     * Get the subscriber activity logs listed by its unique ID.
      *
      * @param {string} subscriberId
      * @param {string[]} queries
@@ -475,28 +568,32 @@ export declare class Messaging extends Service {
     */
     listSubscriberLogs(subscriberId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List topics.
+     * List topics
      *
+     * Get a list of all topics from the current Appwrite project.
      *
-     * @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.
+     * Create topic
      *
+     * Create a new 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.
+     * Get topic
+     *
+     * Get a topic by its unique ID.
      *
      *
      * @param {string} topicId
@@ -505,19 +602,22 @@ export declare class Messaging extends Service {
     */
     getTopic(topicId: string): Promise<Models.Topic>;
     /**
-     * Update a topic.
+     * Update topic
+     *
+     * Update a topic by its unique ID.
      *
      *
      * @param {string} topicId
      * @param {string} name
-     * @param {string} description
+     * @param {string[]} subscribe
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateTopic(topicId: string, name?: string, description?: string): Promise<Models.Topic>;
+    updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
-     * Delete a topic.
+     * Delete topic
      *
+     * Delete a topic by its unique ID.
      *
      * @param {string} topicId
      * @throws {AppwriteException}
@@ -527,6 +627,7 @@ export declare class Messaging extends Service {
     /**
      * List topic logs
      *
+     * Get the topic activity logs listed by its unique ID.
      *
      * @param {string} topicId
      * @param {string[]} queries
@@ -535,19 +636,21 @@ export declare class Messaging extends Service {
     */
     listTopicLogs(topicId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List subscribers.
+     * List subscribers
      *
+     * Get a list of all subscribers from the current Appwrite project.
      *
      * @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.
+     * Create subscriber
      *
+     * Create a new subscriber.
      *
      * @param {string} topicId
      * @param {string} subscriberId
@@ -557,7 +660,9 @@ export declare class Messaging extends Service {
     */
     createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
     /**
-     * Get a subscriber.
+     * Get subscriber
+     *
+     * Get a subscriber by its unique ID.
      *
      *
      * @param {string} topicId
@@ -567,8 +672,9 @@ export declare class Messaging extends Service {
     */
     getSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
     /**
-     * Delete a subscriber.
+     * Delete subscriber
      *
+     * Delete a subscriber by its unique ID.
      *
      * @param {string} topicId
      * @param {string} subscriberId

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,19 +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
+     * Get project usage stats
      *
      *
      * @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
      *