node-appwrite 11.0.0 → 12.0.0-rc.4

package/lib/services/avatars.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Avatars extends Service {
 
@@ -15,19 +17,20 @@ class Avatars extends Service {
 
 
     /**
-     * Get Browser Icon
+     * Get browser icon
      *
      * You can use this endpoint to show different browser icons to your users.
      * The code argument receives the browser code as it appears in your user [GET
-     * /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
-     * width, height and quality arguments to change the output settings.
+     * /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
+     * endpoint. Use width, height and quality arguments to change the output
+     * settings.
      * 
      * When one dimension is specified and the other is 0, the image is scaled
      * with preserved aspect ratio. If both dimensions are 0, the API provides an
      * image at source quality. If dimensions are not specified, the default size
      * of image returned is 100x100px.
      *
-     * @param {string} code
+     * @param {Browser} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
@@ -60,7 +63,7 @@ class Avatars extends Service {
     }
 
     /**
-     * Get Credit Card Icon
+     * Get credit card icon
      *
      * The credit card endpoint will return you the icon of the credit card
      * provider you need. Use width, height and quality arguments to change the
@@ -72,7 +75,7 @@ class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {CreditCard} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
@@ -105,7 +108,7 @@ class Avatars extends Service {
     }
 
     /**
-     * Get Favicon
+     * Get favicon
      *
      * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
      * website URL.
@@ -133,12 +136,12 @@ class Avatars extends Service {
     }
 
     /**
-     * Get Country Flag
+     * Get country flag
      *
      * You can use this endpoint to show different country flags icons to your
      * users. The code argument receives the 2 letter country code. Use width,
      * height and quality arguments to change the output settings. Country codes
-     * follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard.
+     * follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
      * 
      * When one dimension is specified and the other is 0, the image is scaled
      * with preserved aspect ratio. If both dimensions are 0, the API provides an
@@ -146,7 +149,7 @@ class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {Flag} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
@@ -179,7 +182,7 @@ class Avatars extends Service {
     }
 
     /**
-     * Get Image from URL
+     * Get image from URL
      *
      * Use this endpoint to fetch a remote image URL and crop it to any image size
      * you want. This endpoint is very useful if you need to crop and display
@@ -224,7 +227,7 @@ class Avatars extends Service {
     }
 
     /**
-     * Get User Initials
+     * Get user initials
      *
      * Use this endpoint to show your user initials avatar icon on your website or
      * app. By default, this route will try to print your logged-in user name or
@@ -276,7 +279,7 @@ class Avatars extends Service {
     }
 
     /**
-     * Get QR Code
+     * Get QR code
      *
      * Converts a given plain text to a QR code image. You can use the query
      * parameters to change the size and style of the resulting image.

package/lib/services/databases.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Databases extends Service {
 
@@ -15,7 +17,7 @@ class Databases extends Service {
 
 
     /**
-     * List Databases
+     * List databases
      *
      * Get a list of all databases from the current Appwrite project. You can use
      * the search parameter to filter your results.
@@ -43,7 +45,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Database
+     * Create database
      *
      * Create a new Database.
      * 
@@ -84,7 +86,7 @@ class Databases extends Service {
     }
 
     /**
-     * Get Database
+     * Get database
      *
      * Get a database by its unique ID. This endpoint response returns a JSON
      * object with the database metadata.
@@ -107,7 +109,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Database
+     * Update database
      *
      * Update a database by its unique ID.
      *
@@ -143,7 +145,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Database
+     * Delete database
      *
      * Delete a database by its unique ID. Only API keys with with databases.write
      * scope can delete a database.
@@ -166,7 +168,7 @@ class Databases extends Service {
     }
 
     /**
-     * List Collections
+     * List collections
      *
      * Get a list of all collections that belong to the provided databaseId. You
      * can use the search parameter to filter your results.
@@ -199,12 +201,12 @@ class Databases extends Service {
     }
 
     /**
-     * Create Collection
+     * Create collection
      *
      * Create a new Collection. Before using this route, you should create a new
      * database resource using either a [server
-     * integration](/docs/server/databases#databasesCreateCollection) API or
-     * directly from your database console.
+     * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
+     * API or directly from your database console.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -257,7 +259,7 @@ class Databases extends Service {
     }
 
     /**
-     * Get Collection
+     * Get collection
      *
      * Get a collection by its unique ID. This endpoint response returns a JSON
      * object with the collection metadata.
@@ -285,7 +287,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Collection
+     * Update collection
      *
      * Update a collection by its unique ID.
      *
@@ -336,7 +338,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Collection
+     * Delete collection
      *
      * Delete a collection by its unique ID. Only users with write permissions
      * have access to delete this resource.
@@ -364,7 +366,7 @@ class Databases extends Service {
     }
 
     /**
-     * List Attributes
+     * List attributes
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -394,7 +396,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Boolean Attribute
+     * Create boolean attribute
      *
      * Create a boolean attribute.
      * 
@@ -450,7 +452,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Boolean Attribute
+     * Update boolean attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -498,7 +500,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create DateTime Attribute
+     * Create datetime attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -551,7 +553,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update DateTime Attribute
+     * Update dateTime attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -599,7 +601,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Email Attribute
+     * Create email attribute
      *
      * Create an email attribute.
      * 
@@ -655,7 +657,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Email Attribute
+     * Update email attribute
      *
      * Update an email attribute. Changing the `default` value will not update
      * already existing documents.
@@ -707,7 +709,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Enum Attribute
+     * Create enum attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -769,7 +771,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Enum Attribute
+     * Update enum attribute
      *
      * Update an enum attribute. Changing the `default` value will not update
      * already existing documents.
@@ -830,7 +832,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Float Attribute
+     * Create float attribute
      *
      * Create a float attribute. Optionally, minimum and maximum values can be
      * provided.
@@ -897,7 +899,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Float Attribute
+     * Update float attribute
      *
      * Update a float attribute. Changing the `default` value will not update
      * already existing documents.
@@ -967,7 +969,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Integer Attribute
+     * Create integer attribute
      *
      * Create an integer attribute. Optionally, minimum and maximum values can be
      * provided.
@@ -1034,7 +1036,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Integer Attribute
+     * Update integer attribute
      *
      * Update an integer attribute. Changing the `default` value will not update
      * already existing documents.
@@ -1104,7 +1106,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create IP Address Attribute
+     * Create IP address attribute
      *
      * Create IP address attribute.
      * 
@@ -1160,7 +1162,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update IP Address Attribute
+     * Update IP address attribute
      *
      * Update an ip attribute. Changing the `default` value will not update
      * already existing documents.
@@ -1212,20 +1214,20 @@ class Databases extends Service {
     }
 
     /**
-     * Create Relationship Attribute
+     * Create relationship attribute
      *
      * Create relationship attribute. [Learn more about relationship
-     * attributes](/docs/databases-relationships#relationship-attributes).
+     * attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
      * 
      *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} relatedCollectionId
-     * @param {string} type
+     * @param {RelationshipType} type
      * @param {boolean} twoWay
      * @param {string} key
      * @param {string} twoWayKey
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -1279,7 +1281,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create String Attribute
+     * Create string attribute
      *
      * Create a string attribute.
      * 
@@ -1349,7 +1351,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update String Attribute
+     * Update string attribute
      *
      * Update a string attribute. Changing the `default` value will not update
      * already existing documents.
@@ -1401,7 +1403,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create URL Attribute
+     * Create URL attribute
      *
      * Create a URL attribute.
      * 
@@ -1457,7 +1459,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update URL Attribute
+     * Update URL attribute
      *
      * Update an url attribute. Changing the `default` value will not update
      * already existing documents.
@@ -1509,7 +1511,7 @@ class Databases extends Service {
     }
 
     /**
-     * Get Attribute
+     * Get attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1539,7 +1541,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Attribute
+     * Delete attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1569,16 +1571,16 @@ class Databases extends Service {
     }
 
     /**
-     * Update Relationship Attribute
+     * Update relationship attribute
      *
      * Update relationship attribute. [Learn more about relationship
-     * attributes](/docs/databases-relationships#relationship-attributes).
+     * attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
      * 
      *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -1608,7 +1610,7 @@ class Databases extends Service {
     }
 
     /**
-     * List Documents
+     * List documents
      *
      * Get a list of all the user's documents in a given collection. You can use
      * the query params to filter your results.
@@ -1641,12 +1643,12 @@ class Databases extends Service {
     }
 
     /**
-     * Create Document
+     * Create document
      *
      * Create a new Document. Before using this route, you should create a new
      * collection resource using either a [server
-     * integration](/docs/server/databases#databasesCreateCollection) API or
-     * directly from your database console.
+     * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
+     * API or directly from your database console.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1694,7 +1696,7 @@ class Databases extends Service {
     }
 
     /**
-     * Get Document
+     * Get document
      *
      * Get a document by its unique ID. This endpoint response returns a JSON
      * object with the document data.
@@ -1732,7 +1734,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Document
+     * Update document
      *
      * Update a document by its unique ID. Using the patch method you can pass
      * only specific fields that will get updated.
@@ -1775,7 +1777,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Document
+     * Delete document
      *
      * Delete a document by its unique ID.
      *
@@ -1807,7 +1809,7 @@ class Databases extends Service {
     }
 
     /**
-     * List Indexes
+     * List indexes
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1837,12 +1839,12 @@ class Databases extends Service {
     }
 
     /**
-     * Create Index
+     * Create index
      *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} type
+     * @param {IndexType} type
      * @param {string[]} attributes
      * @param {string[]} orders
      * @throws {AppwriteException}
@@ -1894,7 +1896,7 @@ class Databases extends Service {
     }
 
     /**
-     * Get Index
+     * Get index
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1924,7 +1926,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Index
+     * Delete index
      *
      * @param {string} databaseId
      * @param {string} collectionId