node-appwrite 6.0.0 → 7.0.2

package/index.d.ts

@@ -27,6 +27,19 @@ declare module "node-appwrite" {
           collections: Collection[];
       }
       /**
+      * Databases List
+      */
+      export type DatabaseList = {
+          /**
+          * Total number of databases documents that matched your query.
+          */
+          total: number;
+          /**
+          * List of databases.
+          */
+          databases: Database[];
+      }
+      /**
       * Indexes List
       */
       export type IndexList = {
@@ -248,6 +261,19 @@ declare module "node-appwrite" {
           phones: Phone[];
       }
       /**
+      * Database
+      */
+      export type Database = {
+          /**
+          * Database ID.
+          */
+          $id: string;
+          /**
+          * Database name.
+          */
+          name: string;
+      }
+      /**
       * Collection
       */
       export type Collection = {
@@ -256,6 +282,14 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * Collection creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * Collection update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * Collection read permissions.
           */
           $read: string[];
@@ -264,6 +298,10 @@ declare module "node-appwrite" {
           */
           $write: string[];
           /**
+          * Database ID.
+          */
+          databaseId: string;
+          /**
           * Collection name.
           */
           name: string;
@@ -607,6 +645,14 @@ declare module "node-appwrite" {
           */
           $collection: string;
           /**
+          * Document creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * Document update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * Document read permissions.
           */
           $read: string[];
@@ -713,6 +759,14 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * User creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * User update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * User name.
           */
           name: string;
@@ -733,10 +787,18 @@ declare module "node-appwrite" {
           */
           email: string;
           /**
+          * User phone number in E.164 format.
+          */
+          phone: string;
+          /**
           * Email verification status.
           */
           emailVerification: boolean;
           /**
+          * Phone verification status.
+          */
+          phoneVerification: boolean;
+          /**
           * User preferences as a key-value object
           */
           prefs: Preferences;
@@ -755,6 +817,10 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * Session creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
           * User ID.
           */
           userId: string;
@@ -856,6 +922,10 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * Token creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
           * User ID.
           */
           userId: string;
@@ -914,6 +984,14 @@ declare module "node-appwrite" {
           */
           bucketId: string;
           /**
+          * File creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * File update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * File read permissions.
           */
           $read: string[];
@@ -926,10 +1004,6 @@ declare module "node-appwrite" {
           */
           name: string;
           /**
-          * File creation date in Unix timestamp.
-          */
-          dateCreated: number;
-          /**
           * File MD5 signature.
           */
           signature: string;
@@ -959,6 +1033,14 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * Bucket creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * Bucket update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * File read permissions.
           */
           $read: string[];
@@ -971,14 +1053,6 @@ declare module "node-appwrite" {
           */
           permission: string;
           /**
-          * Bucket creation date in Unix timestamp.
-          */
-          dateCreated: number;
-          /**
-          * Bucket update date in Unix timestamp.
-          */
-          dateUpdated: number;
-          /**
           * Bucket name.
           */
           name: string;
@@ -1012,13 +1086,17 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
-          * Team name.
+          * Team creation date in Unix timestamp.
           */
-          name: string;
+          $createdAt: number;
           /**
-          * Team creation date in Unix timestamp.
+          * Team update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
+          * Team name.
           */
-          dateCreated: number;
+          name: string;
           /**
           * Total number of team members.
           */
@@ -1033,6 +1111,14 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * Membership creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * Membership update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * User ID.
           */
           userId: string;
@@ -1078,21 +1164,21 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
-          * Execution permissions.
+          * Function creation date in Unix timestamp.
           */
-          execute: string[];
+          $createdAt: number;
           /**
-          * Function name.
+          * Function update date in Unix timestamp.
           */
-          name: string;
+          $updatedAt: number;
           /**
-          * Function creation date in Unix timestamp.
+          * Execution permissions.
           */
-          dateCreated: number;
+          execute: string[];
           /**
-          * Function update date in Unix timestamp.
+          * Function name.
           */
-          dateUpdated: number;
+          name: string;
           /**
           * Function status. Possible values: `disabled`, `enabled`
           */
@@ -1172,6 +1258,14 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * Deployment creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * Deployment update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * Resource ID.
           */
           resourceId: string;
@@ -1180,10 +1274,6 @@ declare module "node-appwrite" {
           */
           resourceType: string;
           /**
-          * The deployment creation date in Unix timestamp.
-          */
-          dateCreated: number;
-          /**
           * The entrypoint file to use to execute the deployment code.
           */
           entrypoint: string;
@@ -1221,6 +1311,14 @@ declare module "node-appwrite" {
           */
           $id: string;
           /**
+          * Execution creation date in Unix timestamp.
+          */
+          $createdAt: number;
+          /**
+          * Execution update date in Unix timestamp.
+          */
+          $updatedAt: number;
+          /**
           * Execution read permissions.
           */
           $read: string[];
@@ -1229,10 +1327,6 @@ declare module "node-appwrite" {
           */
           functionId: string;
           /**
-          * The execution creation date in Unix timestamp.
-          */
-          dateCreated: number;
-          /**
           * The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
           */
           trigger: string;
@@ -1476,6 +1570,18 @@ declare module "node-appwrite" {
     constructor(client: Client);
   }
 
+  export class InputFile {
+    static fromPath(filePath: string, filename: string): InputFile;
+
+    static fromBuffer(buffer: Buffer, filename: string): InputFile;
+
+    static fromBlob(blob: Blob, filename: string): InputFile;
+
+    static fromStream(stream: any, filename: string, size: number): InputFile;
+
+    static fromPlainText(content: string, filename: string): InputFile;
+  }
+
   type QueryTypesSingle = string | number | boolean;
   type QueryTypesList = string[] | number[] | boolean[];
   type QueryTypes = QueryTypesSingle | QueryTypesList;
@@ -1501,6 +1607,8 @@ declare module "node-appwrite" {
   }
 
   export class Account extends Service {
+    constructor(client: Client);
+    
     /**
      * Get Account
      *
@@ -1563,6 +1671,21 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
+    /**
+     * Update Account Phone
+     *
+     * Update the currently logged in user's phone number. After updating the
+     * phone number, the phone verification status will be reset. A confirmation
+     * SMS is not sent automatically, however you can use the [POST
+     * /account/verification/phone](/docs/client/account#accountCreatePhoneVerification)
+     * endpoint to send a confirmation SMS.
+     *
+     * @param {string} number
+     * @param {string} password
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhone<Preferences extends Models.Preferences>(number: string, password: string): Promise<Models.User<Preferences>>;
     /**
      * Get Account Preferences
      *
@@ -1700,8 +1823,8 @@ declare module "node-appwrite" {
      * should redirect the user back to your app and allow you to complete the
      * verification process by verifying both the **userId** and **secret**
      * parameters. Learn more about how to [complete the verification
-     * process](/docs/client/account#accountUpdateVerification). The verification
-     * link sent to the user's email address is valid for 7 days.
+     * process](/docs/client/account#accountUpdateEmailVerification). The
+     * verification link sent to the user's email address is valid for 7 days.
      * 
      * Please note that in order to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
@@ -1728,8 +1851,38 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     updateVerification(userId: string, secret: string): Promise<Models.Token>;
+    /**
+     * Create Phone Verification
+     *
+     * Use this endpoint to send a verification SMS to the currently logged in
+     * user. This endpoint is meant for use after updating a user's phone number
+     * using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone)
+     * endpoint. Learn more about how to [complete the verification
+     * process](/docs/client/account#accountUpdatePhoneVerification). The
+     * verification code sent to the user's phone number is valid for 15 minutes.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createPhoneVerification(): Promise<Models.Token>;
+    /**
+     * Create Phone Verification (confirmation)
+     *
+     * Use this endpoint to complete the user phone verification process. Use the
+     * **userId** and **secret** that were sent to your user's phone number to
+     * verify the user email ownership. If confirmed this route will return a 200
+     * status code.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhoneVerification(userId: string, secret: string): Promise<Models.Token>;
   }
   export class Avatars extends Service {
+    constructor(client: Client);
+    
     /**
      * Get Browser Icon
      *
@@ -1871,14 +2024,69 @@ declare module "node-appwrite" {
      */
     getQR(text: string, size?: number, margin?: number, download?: boolean): Promise<Buffer>;
   }
-  export class Database extends Service {
+  export class Databases extends Service {
+    constructor(client: Client, databaseId: string);
+    
     /**
-     * List Collections
+     * Get databaseId.
      *
-     * Get a list of all the user collections. You can use the query params to
-     * filter your results. On admin mode, this endpoint will return a list of all
-     * of the project's collections. [Learn more about different API
-     * modes](/docs/admin).
+     * @returns {string}
+     */
+    getDatabaseId(): string;
+
+    /**
+     * Set databaseId.
+     *
+     * @param {string} databaseId
+     * @returns {void}
+     */
+    setDatabaseId(databaseId: string): void;
+
+    /**
+     * List Databases
+     *
+     * @param {string} search
+     * @param {number} limit
+     * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
+     * @param {string} orderType
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    list(search?: string, limit?: number, offset?: number, cursor?: string, cursorDirection?: string, orderType?: string): Promise<Models.DatabaseList>;
+    /**
+     * Create Database
+     *
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    create(name: string): Promise<Models.Database>;
+    /**
+     * Get Database
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get(): Promise<Models.Collection>;
+    /**
+     * Update Database
+     *
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    update(name: string): Promise<Models.Collection>;
+    /**
+     * Delete Database
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    delete(): Promise<Response>;
+    /**
+     * List Collections
      *
      * @param {string} search
      * @param {number} limit
@@ -1893,8 +2101,6 @@ declare module "node-appwrite" {
     /**
      * Create Collection
      *
-     * Create a new Collection.
-     *
      * @param {string} collectionId
      * @param {string} name
      * @param {string} permission
@@ -1907,9 +2113,6 @@ declare module "node-appwrite" {
     /**
      * Get Collection
      *
-     * Get a collection by its unique ID. This endpoint response returns a JSON
-     * object with the collection metadata.
-     *
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -1918,8 +2121,6 @@ declare module "node-appwrite" {
     /**
      * Update Collection
      *
-     * Update a collection by its unique ID.
-     *
      * @param {string} collectionId
      * @param {string} name
      * @param {string} permission
@@ -1933,9 +2134,6 @@ declare module "node-appwrite" {
     /**
      * Delete Collection
      *
-     * Delete a collection by its unique ID. Only users with write permissions
-     * have access to delete this resource.
-     *
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -1952,9 +2150,6 @@ declare module "node-appwrite" {
     /**
      * Create Boolean Attribute
      *
-     * Create a boolean attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -1967,9 +2162,6 @@ declare module "node-appwrite" {
     /**
      * Create Email Attribute
      *
-     * Create an email attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -1995,10 +2187,6 @@ declare module "node-appwrite" {
     /**
      * Create Float Attribute
      *
-     * Create a float attribute. Optionally, minimum and maximum values can be
-     * provided.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -2013,10 +2201,6 @@ declare module "node-appwrite" {
     /**
      * Create Integer Attribute
      *
-     * Create an integer attribute. Optionally, minimum and maximum values can be
-     * provided.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -2031,9 +2215,6 @@ declare module "node-appwrite" {
     /**
      * Create IP Address Attribute
      *
-     * Create IP address attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -2046,9 +2227,6 @@ declare module "node-appwrite" {
     /**
      * Create String Attribute
      *
-     * Create a string attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {number} size
@@ -2062,9 +2240,6 @@ declare module "node-appwrite" {
     /**
      * Create URL Attribute
      *
-     * Create a URL attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -2095,11 +2270,6 @@ declare module "node-appwrite" {
     /**
      * List Documents
      *
-     * Get a list of all the user documents. You can use the query params to
-     * filter your results. On admin mode, this endpoint will return a list of all
-     * of the project's documents. [Learn more about different API
-     * modes](/docs/admin).
-     *
      * @param {string} collectionId
      * @param {string[]} queries
      * @param {number} limit
@@ -2115,11 +2285,6 @@ declare module "node-appwrite" {
     /**
      * Create Document
      *
-     * Create a new Document. Before using this route, you should create a new
-     * collection resource using either a [server
-     * integration](/docs/server/database#databaseCreateCollection) API or
-     * directly from your database console.
-     *
      * @param {string} collectionId
      * @param {string} documentId
      * @param {object} data
@@ -2132,9 +2297,6 @@ declare module "node-appwrite" {
     /**
      * Get Document
      *
-     * Get a document by its unique ID. This endpoint response returns a JSON
-     * object with the document data.
-     *
      * @param {string} collectionId
      * @param {string} documentId
      * @throws {AppwriteException}
@@ -2144,9 +2306,6 @@ declare module "node-appwrite" {
     /**
      * Update Document
      *
-     * Update a document by its unique ID. Using the patch method you can pass
-     * only specific fields that will get updated.
-     *
      * @param {string} collectionId
      * @param {string} documentId
      * @param {object} data
@@ -2155,12 +2314,10 @@ declare module "node-appwrite" {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateDocument<Document extends Models.Document>(collectionId: string, documentId: string, data: object, read?: string[], write?: string[]): Promise<Document>;
+    updateDocument<Document extends Models.Document>(collectionId: string, documentId: string, data?: object, read?: string[], write?: string[]): Promise<Document>;
     /**
      * Delete Document
      *
-     * Delete a document by its unique ID.
-     *
      * @param {string} collectionId
      * @param {string} documentId
      * @throws {AppwriteException}
@@ -2207,6 +2364,8 @@ declare module "node-appwrite" {
     deleteIndex(collectionId: string, key: string): Promise<Response>;
   }
   export class Functions extends Service {
+    constructor(client: Client);
+    
     /**
      * List Functions
      *
@@ -2320,12 +2479,12 @@ declare module "node-appwrite" {
      *
      * @param {string} functionId
      * @param {string} entrypoint
-     * @param {string} code
+     * @param {InputFile} code
      * @param {boolean} activate
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    createDeployment(functionId: string, entrypoint: string, code: string, activate: boolean): Promise<Models.Deployment>;
+    createDeployment(functionId: string, entrypoint: string, code: InputFile, activate: boolean): Promise<Models.Deployment>;
     /**
      * Get Deployment
      *
@@ -2417,6 +2576,8 @@ declare module "node-appwrite" {
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
   }
   export class Health extends Service {
+    constructor(client: Client);
+    
     /**
      * Get HTTP
      *
@@ -2518,6 +2679,8 @@ declare module "node-appwrite" {
     getTime(): Promise<Models.HealthTime>;
   }
   export class Locale extends Service {
+    constructor(client: Client);
+    
     /**
      * Get User Locale
      *
@@ -2595,6 +2758,8 @@ declare module "node-appwrite" {
     getLanguages(): Promise<Models.LanguageList>;
   }
   export class Storage extends Service {
+    constructor(client: Client);
+    
     /**
      * List buckets
      *
@@ -2712,13 +2877,13 @@ declare module "node-appwrite" {
      *
      * @param {string} bucketId
      * @param {string} fileId
-     * @param {string} file
+     * @param {InputFile} file
      * @param {string[]} read
      * @param {string[]} write
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    createFile(bucketId: string, fileId: string, file: string, read?: string[], write?: string[]): Promise<Models.File>;
+    createFile(bucketId: string, fileId: string, file: InputFile, read?: string[], write?: string[]): Promise<Models.File>;
     /**
      * Get File
      *
@@ -2811,6 +2976,8 @@ declare module "node-appwrite" {
     getFileView(bucketId: string, fileId: string): Promise<Buffer>;
   }
   export class Teams extends Service {
+    constructor(client: Client);
+    
     /**
      * List Teams
      *
@@ -2982,6 +3149,8 @@ declare module "node-appwrite" {
     updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
   }
   export class Users extends Service {
+    constructor(client: Client);
+    
     /**
      * List Users
      *
@@ -3090,6 +3259,17 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
+    /**
+     * Update Phone
+     *
+     * Update the user phone by its unique ID.
+     *
+     * @param {string} userId
+     * @param {string} number
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
     /**
      * Get User Preferences
      *
@@ -3166,6 +3346,17 @@ declare module "node-appwrite" {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
+    updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
+    /**
+     * Update Phone Verification
+     *
+     * Update the user phone verification status by its unique ID.
+     *
+     * @param {string} userId
+     * @param {boolean} phoneVerification
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhoneVerification<Preferences extends Models.Preferences>(userId: string, phoneVerification: boolean): Promise<Models.User<Preferences>>;
   }
 }