@appwrite.io/console 0.6.4 → 0.7.0-rc.2

package/types/services/messaging.d.ts

@@ -1,8 +1,8 @@
-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 {
+export declare class Messaging {
+    client: Client;
     constructor(client: Client);
     /**
      * List messages
@@ -12,8 +12,8 @@ export declare class Messaging extends Service {
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.MessageList>}
+     */
     listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
     /**
      * Create email
@@ -33,14 +33,14 @@ export declare class Messaging extends Service {
      * @param {boolean} html
      * @param {string} scheduledAt
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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 email
      *
      * Update an email message by its unique ID.
-     *
+
      *
      * @param {string} messageId
      * @param {string[]} topics
@@ -55,8 +55,8 @@ export declare class Messaging extends Service {
      * @param {string} scheduledAt
      * @param {string[]} attachments
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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, attachments?: string[]): Promise<Models.Message>;
     /**
      * Create push notification
@@ -80,14 +80,14 @@ export declare class Messaging extends Service {
      * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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 push notification
      *
      * Update a push notification by its unique ID.
-     *
+
      *
      * @param {string} messageId
      * @param {string[]} topics
@@ -106,8 +106,8 @@ export declare class Messaging extends Service {
      * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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 SMS
@@ -122,14 +122,14 @@ export declare class Messaging extends Service {
      * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Message>}
+     */
     createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Update SMS
      *
      * Update an email message by its unique ID.
-     *
+
      *
      * @param {string} messageId
      * @param {string[]} topics
@@ -139,30 +139,29 @@ export declare class Messaging extends Service {
      * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Message>}
+     */
     updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
     /**
      * Get message
      *
      * Get a message by its unique ID.
-     *
+
      *
      * @param {string} messageId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Message>}
+     */
     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.
+     * 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}
-    */
+     * @returns {Promise<{}>}
+     */
     delete(messageId: string): Promise<{}>;
     /**
      * List message logs
@@ -172,8 +171,8 @@ export declare class Messaging extends Service {
      * @param {string} messageId
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.LogList>}
+     */
     listMessageLogs(messageId: string, queries?: string[]): Promise<Models.LogList>;
     /**
      * List message targets
@@ -183,8 +182,8 @@ export declare class Messaging extends Service {
      * @param {string} messageId
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.TargetList>}
+     */
     listTargets(messageId: string, queries?: string[]): Promise<Models.TargetList>;
     /**
      * List providers
@@ -194,8 +193,8 @@ export declare class Messaging extends Service {
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.ProviderList>}
+     */
     listProviders(queries?: string[], search?: string): Promise<Models.ProviderList>;
     /**
      * Create APNS provider
@@ -211,8 +210,8 @@ export declare class Messaging extends Service {
      * @param {boolean} sandbox
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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
@@ -228,8 +227,8 @@ export declare class Messaging extends Service {
      * @param {string} bundleId
      * @param {boolean} sandbox
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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
@@ -241,8 +240,8 @@ export declare class Messaging extends Service {
      * @param {object} serviceAccountJSON
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     createFcmProvider(providerId: string, name: string, serviceAccountJSON?: object, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update FCM provider
@@ -254,8 +253,8 @@ export declare class Messaging extends Service {
      * @param {boolean} enabled
      * @param {object} serviceAccountJSON
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
     /**
      * Create Mailgun provider
@@ -273,8 +272,8 @@ export declare class Messaging extends Service {
      * @param {string} replyToEmail
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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
@@ -292,8 +291,8 @@ export declare class Messaging extends Service {
      * @param {string} replyToName
      * @param {string} replyToEmail
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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
@@ -307,8 +306,8 @@ export declare class Messaging extends Service {
      * @param {string} authKey
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     createMsg91Provider(providerId: string, name: string, templateId?: string, senderId?: string, authKey?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update Msg91 provider
@@ -322,8 +321,8 @@ export declare class Messaging extends Service {
      * @param {string} senderId
      * @param {string} authKey
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     updateMsg91Provider(providerId: string, name?: string, enabled?: boolean, templateId?: string, senderId?: string, authKey?: string): Promise<Models.Provider>;
     /**
      * Create Sendgrid provider
@@ -339,8 +338,8 @@ export declare class Messaging extends Service {
      * @param {string} replyToEmail
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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
@@ -356,8 +355,8 @@ export declare class Messaging extends Service {
      * @param {string} replyToName
      * @param {string} replyToEmail
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
     /**
      * Create SMTP provider
@@ -379,8 +378,8 @@ export declare class Messaging extends Service {
      * @param {string} replyToEmail
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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
@@ -402,8 +401,8 @@ export declare class Messaging extends Service {
      * @param {string} replyToEmail
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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
@@ -417,8 +416,8 @@ export declare class Messaging extends Service {
      * @param {string} apiKey
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     createTelesignProvider(providerId: string, name: string, from?: string, customerId?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update Telesign provider
@@ -432,8 +431,8 @@ export declare class Messaging extends Service {
      * @param {string} apiKey
      * @param {string} from
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     updateTelesignProvider(providerId: string, name?: string, enabled?: boolean, customerId?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
     /**
      * Create Textmagic provider
@@ -447,8 +446,8 @@ export declare class Messaging extends Service {
      * @param {string} apiKey
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     createTextmagicProvider(providerId: string, name: string, from?: string, username?: string, apiKey?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update Textmagic provider
@@ -462,8 +461,8 @@ export declare class Messaging extends Service {
      * @param {string} apiKey
      * @param {string} from
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     updateTextmagicProvider(providerId: string, name?: string, enabled?: boolean, username?: string, apiKey?: string, from?: string): Promise<Models.Provider>;
     /**
      * Create Twilio provider
@@ -477,8 +476,8 @@ export declare class Messaging extends Service {
      * @param {string} authToken
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     createTwilioProvider(providerId: string, name: string, from?: string, accountSid?: string, authToken?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update Twilio provider
@@ -492,8 +491,8 @@ export declare class Messaging extends Service {
      * @param {string} authToken
      * @param {string} from
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     updateTwilioProvider(providerId: string, name?: string, enabled?: boolean, accountSid?: string, authToken?: string, from?: string): Promise<Models.Provider>;
     /**
      * Create Vonage provider
@@ -507,8 +506,8 @@ export declare class Messaging extends Service {
      * @param {string} apiSecret
      * @param {boolean} enabled
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     createVonageProvider(providerId: string, name: string, from?: string, apiKey?: string, apiSecret?: string, enabled?: boolean): Promise<Models.Provider>;
     /**
      * Update Vonage provider
@@ -522,19 +521,19 @@ export declare class Messaging extends Service {
      * @param {string} apiSecret
      * @param {string} from
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     updateVonageProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, apiSecret?: string, from?: string): Promise<Models.Provider>;
     /**
      * Get provider
      *
      * Get a provider by its unique ID.
-     *
+
      *
      * @param {string} providerId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Provider>}
+     */
     getProvider(providerId: string): Promise<Models.Provider>;
     /**
      * Delete provider
@@ -543,8 +542,8 @@ export declare class Messaging extends Service {
      *
      * @param {string} providerId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteProvider(providerId: string): Promise<{}>;
     /**
      * List provider logs
@@ -554,8 +553,8 @@ export declare class Messaging extends Service {
      * @param {string} providerId
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.LogList>}
+     */
     listProviderLogs(providerId: string, queries?: string[]): Promise<Models.LogList>;
     /**
      * List subscriber logs
@@ -565,8 +564,8 @@ export declare class Messaging extends Service {
      * @param {string} subscriberId
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.LogList>}
+     */
     listSubscriberLogs(subscriberId: string, queries?: string[]): Promise<Models.LogList>;
     /**
      * List topics
@@ -576,8 +575,8 @@ export declare class Messaging extends Service {
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.TopicList>}
+     */
     listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
     /**
      * Create topic
@@ -588,32 +587,32 @@ export declare class Messaging extends Service {
      * @param {string} name
      * @param {string[]} subscribe
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Topic>}
+     */
     createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
      * Get topic
      *
      * Get a topic by its unique ID.
-     *
+
      *
      * @param {string} topicId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Topic>}
+     */
     getTopic(topicId: string): Promise<Models.Topic>;
     /**
      * Update topic
      *
      * Update a topic by its unique ID.
-     *
+
      *
      * @param {string} topicId
      * @param {string} name
      * @param {string[]} subscribe
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Topic>}
+     */
     updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
      * Delete topic
@@ -622,8 +621,8 @@ export declare class Messaging extends Service {
      *
      * @param {string} topicId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteTopic(topicId: string): Promise<{}>;
     /**
      * List topic logs
@@ -633,8 +632,8 @@ export declare class Messaging extends Service {
      * @param {string} topicId
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.LogList>}
+     */
     listTopicLogs(topicId: string, queries?: string[]): Promise<Models.LogList>;
     /**
      * List subscribers
@@ -645,8 +644,8 @@ export declare class Messaging extends Service {
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.SubscriberList>}
+     */
     listSubscribers(topicId: string, queries?: string[], search?: string): Promise<Models.SubscriberList>;
     /**
      * Create subscriber
@@ -657,20 +656,20 @@ export declare class Messaging extends Service {
      * @param {string} subscriberId
      * @param {string} targetId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Subscriber>}
+     */
     createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
     /**
      * Get subscriber
      *
      * Get a subscriber by its unique ID.
-     *
+
      *
      * @param {string} topicId
      * @param {string} subscriberId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Subscriber>}
+     */
     getSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
     /**
      * Delete subscriber
@@ -680,7 +679,7 @@ export declare class Messaging extends Service {
      * @param {string} topicId
      * @param {string} subscriberId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
 }