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

package/src/services/messaging.ts

@@ -2,7 +2,6 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { MessageStatus } from '../enums/message-status';
 import { SmtpEncryption } from '../enums/smtp-encryption';
 
 export class Messaging extends Service {
@@ -41,7 +40,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Create an email
+     * Create email
      *
      * Create a new email message.
      *
@@ -54,13 +53,13 @@ export 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}
     */
-    async 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> {
+    async 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> {
         if (typeof messageId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "messageId"');
         }
@@ -112,8 +111,8 @@ export class Messaging extends Service {
             payload['attachments'] = attachments;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof html !== 'undefined') {
@@ -131,7 +130,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Update an email
+     * Update email
      *
      * Update an email message by its unique ID.
      * 
@@ -142,7 +141,7 @@ export 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
@@ -150,7 +149,7 @@ export class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async 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> {
+    async 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> {
         if (typeof messageId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "messageId"');
         }
@@ -178,8 +177,8 @@ export class Messaging extends Service {
             payload['content'] = content;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof html !== 'undefined') {
@@ -205,7 +204,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Create a push notification
+     * Create push notification
      *
      * Create a new push notification.
      *
@@ -223,12 +222,12 @@ export 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}
     */
-    async 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> {
+    async 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> {
         if (typeof messageId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "messageId"');
         }
@@ -300,8 +299,8 @@ export class Messaging extends Service {
             payload['badge'] = badge;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -315,7 +314,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Update a push notification
+     * Update push notification
      *
      * Update a push notification by its unique ID.
      * 
@@ -334,12 +333,12 @@ export 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}
     */
-    async 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> {
+    async 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> {
         if (typeof messageId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "messageId"');
         }
@@ -399,8 +398,8 @@ export class Messaging extends Service {
             payload['badge'] = badge;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -414,7 +413,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Create an SMS
+     * Create SMS
      *
      * Create a new SMS message.
      *
@@ -423,12 +422,12 @@ export 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}
     */
-    async createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], status?: MessageStatus, scheduledAt?: string): Promise<Models.Message> {
+    async createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message> {
         if (typeof messageId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "messageId"');
         }
@@ -460,8 +459,8 @@ export class Messaging extends Service {
             payload['targets'] = targets;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -475,7 +474,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Update an SMS
+     * Update SMS
      *
      * Update an email message by its unique ID.
      * 
@@ -485,12 +484,12 @@ export 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}
     */
-    async updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, status?: MessageStatus, scheduledAt?: string): Promise<Models.Message> {
+    async updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message> {
         if (typeof messageId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "messageId"');
         }
@@ -514,8 +513,8 @@ export class Messaging extends Service {
             payload['content'] = content;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -529,7 +528,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Get a message
+     * Get message
      *
      * Get a message by its unique ID.
      * 
@@ -553,8 +552,10 @@ export class Messaging extends Service {
     }
 
     /**
-     * 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}
@@ -1117,6 +1118,7 @@ export class Messaging extends Service {
     /**
      * Create Sendgrid provider
      *
+     * Create a new Sendgrid provider.
      *
      * @param {string} providerId
      * @param {string} name
@@ -1973,7 +1975,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Create a topic
+     * Create topic
      *
      * Create a new topic.
      *
@@ -2014,7 +2016,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Get a topic
+     * Get topic
      *
      * Get a topic by its unique ID.
      * 
@@ -2038,7 +2040,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Update a topic
+     * Update topic
      *
      * Update a topic by its unique ID.
      * 
@@ -2072,7 +2074,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Delete a topic
+     * Delete topic
      *
      * Delete a topic by its unique ID.
      *
@@ -2156,7 +2158,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Create a subscriber
+     * Create subscriber
      *
      * Create a new subscriber.
      *
@@ -2197,7 +2199,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Get a subscriber
+     * Get subscriber
      *
      * Get a subscriber by its unique ID.
      * 
@@ -2226,7 +2228,7 @@ export class Messaging extends Service {
     }
 
     /**
-     * Delete a subscriber
+     * Delete subscriber
      *
      * Delete a subscriber by its unique ID.
      *

package/src/services/project.ts

@@ -12,7 +12,7 @@ export class Project extends Service {
      }
 
     /**
-     * Get usage stats for a project
+     * Get project usage stats
      *
      *
      * @param {string} startDate

package/src/services/storage.ts

@@ -640,7 +640,7 @@ export class Storage extends Service {
     }
 
     /**
-     * Get usage stats for storage
+     * Get storage usage stats
      *
      *
      * @param {StorageUsageRange} range
@@ -662,7 +662,7 @@ export class Storage extends Service {
     }
 
     /**
-     * Get usage stats for storage bucket
+     * Get bucket usage stats
      *
      *
      * @param {string} bucketId

package/src/services/users.ts

@@ -591,7 +591,7 @@ export class Users extends Service {
     }
 
     /**
-     * Get usage stats for the users API
+     * Get users usage stats
      *
      *
      * @param {UserUsageRange} range
@@ -786,6 +786,7 @@ export class Users extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on a user account.
      *
      * @param {string} userId
      * @param {boolean} mfa
@@ -817,6 +818,7 @@ export 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}
@@ -839,14 +841,14 @@ export class Users extends Service {
     /**
      * Delete Authenticator
      *
+     * Delete an authenticator app.
      *
      * @param {string} userId
      * @param {AuthenticatorType} type
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>> {
+    async deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType): Promise<Models.User<Preferences>> {
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
@@ -855,17 +857,9 @@ export class Users extends Service {
             throw new AppwriteException('Missing required parameter: "type"');
         }
 
-        if (typeof otp === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "otp"');
-        }
-
         const apiPath = '/users/{userId}/mfa/{type}'.replace('{userId}', userId).replace('{type}', type);
         const payload: Payload = {};
 
-        if (typeof otp !== 'undefined') {
-            payload['otp'] = otp;
-        }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('delete', uri, {
             'content-type': 'application/json',
@@ -1163,6 +1157,7 @@ export class Users extends Service {
     /**
      * List User Targets
      *
+     * List the messaging targets that are associated with a user.
      *
      * @param {string} userId
      * @param {string[]} queries
@@ -1190,6 +1185,7 @@ export class Users extends Service {
     /**
      * Create User Target
      *
+     * Create a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -1249,6 +1245,7 @@ export class Users extends Service {
     /**
      * Get User Target
      *
+     * Get a user's push notification target by ID.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -1276,6 +1273,7 @@ export class Users extends Service {
     /**
      * Update User target
      *
+     * Update a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -1318,6 +1316,7 @@ export class Users extends Service {
     /**
      * Delete user target
      *
+     * Delete a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId

package/types/enums/index-type.d.ts

@@ -1,6 +1,5 @@
 export declare enum IndexType {
     Key = "key",
     Fulltext = "fulltext",
-    Unique = "unique",
-    Spatial = "spatial"
+    Unique = "unique"
 }

package/types/index.d.ts

@@ -36,7 +36,6 @@ export { Runtime } from './enums/runtime';
 export { FunctionUsageRange } from './enums/function-usage-range';
 export { ExecutionMethod } from './enums/execution-method';
 export { Name } from './enums/name';
-export { MessageStatus } from './enums/message-status';
 export { SmtpEncryption } from './enums/smtp-encryption';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';

package/types/services/account.d.ts

@@ -108,6 +108,7 @@ export declare class Account extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on an account.
      *
      * @param {boolean} mfa
      * @throws {AppwriteException}
@@ -126,6 +127,7 @@ export declare class Account extends Service {
     /**
      * Create MFA Challenge (confirmation)
      *
+     * Complete the MFA challenge by providing the one-time password.
      *
      * @param {string} challengeId
      * @param {string} otp
@@ -136,6 +138,7 @@ export declare class Account extends Service {
     /**
      * List Factors
      *
+     * List the factors available on the account to be used as a MFA challange.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -144,6 +147,10 @@ export declare class Account extends Service {
     /**
      * Add Authenticator
      *
+     * Add an authenticator app to be used as an MFA factor. Verify the
+     * authenticator using the [verify
+     * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
+     * method.
      *
      * @param {AuthenticatorType} type
      * @throws {AppwriteException}
@@ -153,6 +160,9 @@ export declare class Account extends Service {
     /**
      * Verify Authenticator
      *
+     * Verify an authenticator app after adding it using the [add
+     * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+     * method.
      *
      * @param {AuthenticatorType} type
      * @param {string} otp
@@ -163,6 +173,7 @@ export declare class Account extends Service {
     /**
      * Delete Authenticator
      *
+     * Delete an authenticator for a user by ID.
      *
      * @param {AuthenticatorType} type
      * @param {string} otp
@@ -320,7 +331,7 @@ export declare class Account extends Service {
     */
     createEmailPasswordSession(email: string, password: string): Promise<Models.Session>;
     /**
-     * Create session (deprecated)
+     * Update magic URL session
      *
      * Use this endpoint to create a session from token. Provide the **userId**
      * and **secret** parameters from the successful response of authentication
@@ -360,6 +371,19 @@ export declare class Account extends Service {
      * @returns {void|string}
     */
     createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
+    /**
+     * Update phone session
+     *
+     * Use this endpoint to create a session from token. Provide the **userId**
+     * and **secret** parameters from the successful response of authentication
+     * flows initiated by token creation. For example, magic URL and phone login.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
     /**
      * Create session
      *
@@ -385,7 +409,7 @@ export declare class Account extends Service {
     */
     getSession(sessionId: string): Promise<Models.Session>;
     /**
-     * Update (or renew) a session
+     * Update (or renew) session
      *
      * Extend session's expiry to increase it's lifespan. Extending a session is
      * useful when session length is short such as 5 minutes.
@@ -421,7 +445,7 @@ export declare class Account extends Service {
     */
     updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
-     * Create a push target
+     * Create push target
      *
      *
      * @param {string} targetId
@@ -432,7 +456,7 @@ export declare class Account extends Service {
     */
     createPushTarget(targetId: string, identifier: string, providerId?: string): Promise<Models.Target>;
     /**
-     * Update a push target
+     * Update push target
      *
      *
      * @param {string} targetId
@@ -442,7 +466,7 @@ export declare class Account extends Service {
     */
     updatePushTarget(targetId: string, identifier: string): Promise<Models.Target>;
     /**
-     * Delete a push target
+     * Delete push target
      *
      *
      * @param {string} targetId

package/types/services/databases.d.ts

@@ -33,7 +33,7 @@ export declare class Databases extends Service {
     */
     create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Get usage stats for the database
+     * Get databases usage stats
      *
      *
      * @param {DatabaseUsageRange} range
@@ -148,6 +148,7 @@ export declare class Databases extends Service {
     /**
      * List attributes
      *
+     * List attributes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -175,6 +176,8 @@ export declare class Databases extends Service {
     /**
      * Update boolean attribute
      *
+     * Update a boolean attribute. Changing the `default` value will not update
+     * already existing documents.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -188,6 +191,7 @@ export declare class Databases extends Service {
     /**
      * Create datetime attribute
      *
+     * Create a date time attribute according to the ISO 8601 standard.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -202,6 +206,8 @@ export declare class Databases extends Service {
     /**
      * Update dateTime attribute
      *
+     * Update a date time attribute. Changing the `default` value will not update
+     * already existing documents.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -247,6 +253,9 @@ export declare class Databases extends Service {
     /**
      * Create enum attribute
      *
+     * Create an enumeration attribute. The `elements` param acts as a white-list
+     * of accepted values for this attribute.
+     *
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -470,6 +479,7 @@ export declare class Databases extends Service {
     /**
      * Get attribute
      *
+     * Get attribute by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -481,6 +491,7 @@ export declare class Databases extends Service {
     /**
      * Delete attribute
      *
+     * Deletes an attribute.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -591,6 +602,7 @@ export declare class Databases extends Service {
     /**
      * List indexes
      *
+     * List indexes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -602,6 +614,9 @@ export declare class Databases extends Service {
     /**
      * Create index
      *
+     * Creates an index on the attributes listed. Your index should include all
+     * the attributes you will query in a single request.
+     * Attributes can be `key`, `fulltext`, and `unique`.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -616,6 +631,7 @@ export declare class Databases extends Service {
     /**
      * Get index
      *
+     * Get index by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -627,6 +643,7 @@ export declare class Databases extends Service {
     /**
      * Delete index
      *
+     * Delete an index.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -648,7 +665,7 @@ export declare class Databases extends Service {
     */
     listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get usage stats for a collection
+     * Get collection usage stats
      *
      *
      * @param {string} databaseId
@@ -670,7 +687,7 @@ export declare class Databases extends Service {
     */
     listLogs(databaseId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get usage stats for the database
+     * Get database usage stats
      *
      *
      * @param {string} databaseId

package/types/services/health.d.ts

@@ -131,6 +131,8 @@ export declare class Health extends Service {
     /**
      * Get functions queue
      *
+     * Get the number of function executions that are waiting to be processed in
+     * the Appwrite internal queue server.
      *
      * @param {number} threshold
      * @throws {AppwriteException}