@appwrite.io/console 0.6.0-rc.13 → 0.6.0-rc.14

package/types/services/messaging.d.ts

@@ -1,7 +1,6 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
-import { MessageStatus } from '../enums/message-status';
 import { SmtpEncryption } from '../enums/smtp-encryption';
 export declare class Messaging extends Service {
     constructor(client: Client);
@@ -17,7 +16,7 @@ export declare class Messaging extends Service {
     */
     listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
     /**
-     * Create an email
+     * Create email
      *
      * Create a new email message.
      *
@@ -30,15 +29,15 @@ export declare class Messaging extends Service {
      * @param {string[]} cc
      * @param {string[]} bcc
      * @param {string[]} attachments
-     * @param {MessageStatus} status
+     * @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[], attachments?: string[], status?: MessageStatus, 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.
      *
@@ -49,7 +48,7 @@ export declare class Messaging extends Service {
      * @param {string[]} targets
      * @param {string} subject
      * @param {string} content
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {boolean} html
      * @param {string[]} cc
      * @param {string[]} bcc
@@ -57,9 +56,9 @@ export declare class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    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>;
+    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.
      *
@@ -77,14 +76,14 @@ export declare class Messaging extends Service {
      * @param {string} color
      * @param {string} tag
      * @param {string} badge
-     * @param {MessageStatus} 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, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, status?: MessageStatus, 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.
      *
@@ -103,14 +102,14 @@ export declare class Messaging extends Service {
      * @param {string} color
      * @param {string} tag
      * @param {number} badge
-     * @param {MessageStatus} 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, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, status?: MessageStatus, 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.
      *
@@ -119,14 +118,14 @@ export declare class Messaging extends Service {
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], status?: MessageStatus, 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.
      *
@@ -136,14 +135,14 @@ export declare class Messaging extends Service {
      * @param {string[]} users
      * @param {string[]} targets
      * @param {string} content
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, status?: MessageStatus, 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.
      *
@@ -154,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}
@@ -326,6 +327,7 @@ export declare class Messaging extends Service {
     /**
      * Create Sendgrid provider
      *
+     * Create a new Sendgrid provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -577,7 +579,7 @@ export declare class Messaging extends Service {
     */
     listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
     /**
-     * Create a topic
+     * Create topic
      *
      * Create a new topic.
      *
@@ -589,7 +591,7 @@ export declare class Messaging extends Service {
     */
     createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
-     * Get a topic
+     * Get topic
      *
      * Get a topic by its unique ID.
      *
@@ -600,7 +602,7 @@ export declare class Messaging extends Service {
     */
     getTopic(topicId: string): Promise<Models.Topic>;
     /**
-     * Update a topic
+     * Update topic
      *
      * Update a topic by its unique ID.
      *
@@ -613,7 +615,7 @@ export declare class Messaging extends Service {
     */
     updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
     /**
-     * Delete a topic
+     * Delete topic
      *
      * Delete a topic by its unique ID.
      *
@@ -646,7 +648,7 @@ 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.
      *
@@ -658,7 +660,7 @@ 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.
      *
@@ -670,7 +672,7 @@ 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.
      *

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

package/types/services/storage.d.ts

@@ -213,7 +213,7 @@ export declare class Storage extends Service {
     */
     getFileView(bucketId: string, fileId: string): URL;
     /**
-     * Get usage stats for storage
+     * Get storage usage stats
      *
      *
      * @param {StorageUsageRange} range
@@ -222,7 +222,7 @@ export declare class Storage extends Service {
     */
     getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage>;
     /**
-     * Get usage stats for storage bucket
+     * Get bucket usage stats
      *
      *
      * @param {string} bucketId

package/types/services/users.d.ts

@@ -177,7 +177,7 @@ export declare class Users extends Service {
     */
     createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Get usage stats for the users API
+     * Get users usage stats
      *
      *
      * @param {UserUsageRange} range
@@ -261,6 +261,7 @@ export declare class Users extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on a user account.
      *
      * @param {string} userId
      * @param {boolean} mfa
@@ -271,6 +272,7 @@ export declare class Users extends Service {
     /**
      * List Factors
      *
+     * List the factors available on the account to be used as a MFA challange.
      *
      * @param {string} userId
      * @throws {AppwriteException}
@@ -280,14 +282,14 @@ export declare class Users extends Service {
     /**
      * Delete Authenticator
      *
+     * Delete an authenticator app.
      *
      * @param {string} userId
      * @param {AuthenticatorType} type
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
+    deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType): Promise<Models.User<Preferences>>;
     /**
      * Update name
      *
@@ -405,6 +407,7 @@ export declare class Users extends Service {
     /**
      * List User Targets
      *
+     * List the messaging targets that are associated with a user.
      *
      * @param {string} userId
      * @param {string[]} queries
@@ -415,6 +418,7 @@ export declare class Users extends Service {
     /**
      * Create User Target
      *
+     * Create a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -429,6 +433,7 @@ export declare class Users extends Service {
     /**
      * Get User Target
      *
+     * Get a user's push notification target by ID.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -439,6 +444,7 @@ export declare class Users extends Service {
     /**
      * Update User target
      *
+     * Update a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -452,6 +458,7 @@ export declare class Users extends Service {
     /**
      * Delete user target
      *
+     * Delete a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId

package/src/enums/message-status.ts

@@ -1,5 +0,0 @@
-export enum MessageStatus {
-    Draft = 'draft',
-    Scheduled = 'scheduled',
-    Processing = 'processing',
-}

package/types/enums/message-status.d.ts

@@ -1,5 +0,0 @@
-export declare enum MessageStatus {
-    Draft = "draft",
-    Scheduled = "scheduled",
-    Processing = "processing"
-}