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

package/types/services/messaging.d.ts

@@ -1,13 +1,13 @@
 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';
+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} search
@@ -16,8 +16,9 @@ export declare class Messaging extends Service {
     */
     listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
     /**
-     * Create an email.
+     * Create email
      *
+     * Create a new email message.
      *
      * @param {string} messageId
      * @param {string} subject
@@ -27,15 +28,18 @@ export declare class Messaging extends Service {
      * @param {string[]} targets
      * @param {string[]} cc
      * @param {string[]} bcc
-     * @param {MessageType} 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[], status?: MessageType, 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
@@ -44,7 +48,7 @@ export declare class Messaging extends Service {
      * @param {string[]} targets
      * @param {string} subject
      * @param {string} content
-     * @param {MessageType} 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, content?: string, status?: MessageType, 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
@@ -65,19 +70,22 @@ export declare class Messaging extends Service {
      * @param {string[]} targets
      * @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 {MessageType} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    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>;
+    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
@@ -88,34 +96,38 @@ export declare class Messaging extends Service {
      * @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 {MessageType} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    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>;
+    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 {MessageType} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSMS(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], status?: MessageType, 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
@@ -123,14 +135,16 @@ export declare class Messaging extends Service {
      * @param {string[]} users
      * @param {string[]} targets
      * @param {string} content
-     * @param {MessageType} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSMS(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, status?: MessageType, 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
@@ -139,8 +153,10 @@ export declare class Messaging extends Service {
     */
     getMessage(messageId: string): Promise<Models.Message>;
     /**
-     * Delete a 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}
@@ -150,6 +166,7 @@ export declare class Messaging extends Service {
     /**
      * List message logs
      *
+     * Get the message activity logs listed by its unique ID.
      *
      * @param {string} messageId
      * @param {string[]} queries
@@ -160,8 +177,7 @@ 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
@@ -172,6 +188,7 @@ export declare class Messaging extends Service {
     /**
      * List providers
      *
+     * Get a list of all providers from the current Appwrite project.
      *
      * @param {string[]} queries
      * @param {string} search
@@ -182,6 +199,7 @@ export declare class Messaging extends Service {
     /**
      * Create APNS provider
      *
+     * Create a new Apple Push Notification service provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -189,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
@@ -205,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
@@ -220,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
@@ -232,10 +255,11 @@ 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
@@ -254,6 +278,7 @@ export declare class Messaging extends Service {
     /**
      * Update Mailgun provider
      *
+     * Update a Mailgun provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -272,6 +297,7 @@ export declare class Messaging extends Service {
     /**
      * Create Msg91 provider
      *
+     * Create a new MSG91 provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -286,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
@@ -300,6 +327,7 @@ export declare class Messaging extends Service {
     /**
      * Create Sendgrid provider
      *
+     * Create a new Sendgrid provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -316,6 +344,7 @@ export declare class Messaging extends Service {
     /**
      * Update Sendgrid provider
      *
+     * Update a Sendgrid provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -332,6 +361,7 @@ export declare class Messaging extends Service {
     /**
      * Create SMTP provider
      *
+     * Create a new SMTP provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -339,7 +369,7 @@ export declare class Messaging extends Service {
      * @param {number} port
      * @param {string} username
      * @param {string} password
-     * @param {SMTPEncryption} encryption
+     * @param {SmtpEncryption} encryption
      * @param {boolean} autoTLS
      * @param {string} mailer
      * @param {string} fromName
@@ -350,10 +380,11 @@ export declare class Messaging extends Service {
      * @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>;
+    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
      *
+     * Update a SMTP provider by its unique ID.
      *
      * @param {string} providerId
      * @param {string} name
@@ -361,8 +392,9 @@ export declare class Messaging extends Service {
      * @param {number} port
      * @param {string} username
      * @param {string} password
-     * @param {SMTPEncryption} encryption
+     * @param {SmtpEncryption} encryption
      * @param {boolean} autoTLS
+     * @param {string} mailer
      * @param {string} fromName
      * @param {string} fromEmail
      * @param {string} replyToName
@@ -371,38 +403,41 @@ export declare class Messaging extends Service {
      * @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>;
+    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} username
-     * @param {string} password
+     * @param {string} customerId
+     * @param {string} apiKey
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createTelesignProvider(providerId: string, name: string, from?: string, username?: string, password?: string, enabled?: boolean): Promise<Models.Provider>;
+    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} username
-     * @param {string} password
+     * @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
@@ -417,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
@@ -431,6 +467,7 @@ export declare class Messaging extends Service {
     /**
      * Create Twilio provider
      *
+     * Create a new Twilio provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -445,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
@@ -459,6 +497,7 @@ export declare class Messaging extends Service {
     /**
      * Create Vonage provider
      *
+     * Create a new Vonage provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -473,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
@@ -487,6 +527,8 @@ export declare class Messaging extends Service {
     /**
      * Get provider
      *
+     * Get a provider by its unique ID.
+     *
      *
      * @param {string} providerId
      * @throws {AppwriteException}
@@ -496,6 +538,7 @@ export declare class Messaging extends Service {
     /**
      * Delete provider
      *
+     * Delete a provider by its unique ID.
      *
      * @param {string} providerId
      * @throws {AppwriteException}
@@ -505,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
@@ -515,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
@@ -523,8 +568,9 @@ 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} search
@@ -533,17 +579,21 @@ export declare class Messaging extends Service {
     */
     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[]} subscribe
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createTopic(topicId: string, name: 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
@@ -552,18 +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[]} subscribe
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateTopic(topicId: string, name?: 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}
@@ -573,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
@@ -581,8 +636,9 @@ 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
@@ -592,8 +648,9 @@ export declare class Messaging extends Service {
     */
     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
@@ -603,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
@@ -613,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/project.d.ts

@@ -5,7 +5,7 @@ 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