node-appwrite 11.0.0 → 11.1.1

package/lib/services/databases.js

@@ -15,7 +15,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 +43,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Database
+     * Create database
      *
      * Create a new Database.
      * 
@@ -84,7 +84,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 +107,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Database
+     * Update database
      *
      * Update a database by its unique ID.
      *
@@ -143,7 +143,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 +166,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 +199,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 +257,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 +285,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Collection
+     * Update collection
      *
      * Update a collection by its unique ID.
      *
@@ -336,7 +336,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 +364,7 @@ class Databases extends Service {
     }
 
     /**
-     * List Attributes
+     * List attributes
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -394,7 +394,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Boolean Attribute
+     * Create boolean attribute
      *
      * Create a boolean attribute.
      * 
@@ -450,7 +450,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update Boolean Attribute
+     * Update boolean attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -498,7 +498,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create DateTime Attribute
+     * Create datetime attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -551,7 +551,7 @@ class Databases extends Service {
     }
 
     /**
-     * Update DateTime Attribute
+     * Update dateTime attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -599,7 +599,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Email Attribute
+     * Create email attribute
      *
      * Create an email attribute.
      * 
@@ -655,7 +655,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 +707,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Enum Attribute
+     * Create enum attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -769,7 +769,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 +830,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 +897,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 +967,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 +1034,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 +1104,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create IP Address Attribute
+     * Create IP address attribute
      *
      * Create IP address attribute.
      * 
@@ -1160,7 +1160,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,10 +1212,10 @@ 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
@@ -1279,7 +1279,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create String Attribute
+     * Create string attribute
      *
      * Create a string attribute.
      * 
@@ -1349,7 +1349,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 +1401,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create URL Attribute
+     * Create URL attribute
      *
      * Create a URL attribute.
      * 
@@ -1457,7 +1457,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 +1509,7 @@ class Databases extends Service {
     }
 
     /**
-     * Get Attribute
+     * Get attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1539,7 +1539,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Attribute
+     * Delete attribute
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1569,10 +1569,10 @@ 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
@@ -1608,7 +1608,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 +1641,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 +1694,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 +1732,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 +1775,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Document
+     * Delete document
      *
      * Delete a document by its unique ID.
      *
@@ -1807,7 +1807,7 @@ class Databases extends Service {
     }
 
     /**
-     * List Indexes
+     * List indexes
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1837,7 +1837,7 @@ class Databases extends Service {
     }
 
     /**
-     * Create Index
+     * Create index
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1894,7 +1894,7 @@ class Databases extends Service {
     }
 
     /**
-     * Get Index
+     * Get index
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1924,7 +1924,7 @@ class Databases extends Service {
     }
 
     /**
-     * Delete Index
+     * Delete index
      *
      * @param {string} databaseId
      * @param {string} collectionId

package/lib/services/functions.js

@@ -15,7 +15,7 @@ class Functions extends Service {
 
 
     /**
-     * List Functions
+     * List functions
      *
      * Get a list of all the project's functions. You can use the query params to
      * filter your results.
@@ -43,11 +43,12 @@ class Functions extends Service {
     }
 
     /**
-     * Create Function
+     * Create function
      *
      * Create a new function. You can pass a list of
-     * [permissions](/docs/permissions) to allow different project users or team
-     * with access to execute the function using the client API.
+     * [permissions](https://appwrite.io/docs/permissions) to allow different
+     * project users or team with access to execute the function using the client
+     * API.
      *
      * @param {string} functionId
      * @param {string} name
@@ -191,7 +192,7 @@ class Functions extends Service {
     }
 
     /**
-     * Get Function
+     * Get function
      *
      * Get a function by its unique ID.
      *
@@ -213,7 +214,7 @@ class Functions extends Service {
     }
 
     /**
-     * Update Function
+     * Update function
      *
      * Update function by its unique ID.
      *
@@ -314,7 +315,7 @@ class Functions extends Service {
     }
 
     /**
-     * Delete Function
+     * Delete function
      *
      * Delete a function by its unique ID.
      *
@@ -336,7 +337,7 @@ class Functions extends Service {
     }
 
     /**
-     * List Deployments
+     * List deployments
      *
      * Get a list of all the project's code deployments. You can use the query
      * params to filter your results.
@@ -369,7 +370,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Deployment
+     * Create deployment
      *
      * Create a new function code deployment. Use this endpoint to upload a new
      * version of your code function. To execute your newly uploaded code, you'll
@@ -378,7 +379,7 @@ class Functions extends Service {
      * This endpoint accepts a tar.gz file compressed with your code. Make sure to
      * include any dependencies your code has within the compressed file. You can
      * learn more about code packaging in the [Appwrite Cloud Functions
-     * tutorial](/docs/functions).
+     * tutorial](https://appwrite.io/docs/functions).
      * 
      * Use the "command" param to set the entrypoint used to execute your code.
      *
@@ -550,7 +551,7 @@ class Functions extends Service {
     }
 
     /**
-     * Get Deployment
+     * Get deployment
      *
      * Get a code deployment by its unique ID.
      *
@@ -577,7 +578,7 @@ class Functions extends Service {
     }
 
     /**
-     * Update Function Deployment
+     * Update function deployment
      *
      * Update the function code deployment ID using the unique function ID. Use
      * this endpoint to switch the code deployment that should be executed by the
@@ -606,7 +607,7 @@ class Functions extends Service {
     }
 
     /**
-     * Delete Deployment
+     * Delete deployment
      *
      * Delete a code deployment by its unique ID.
      *
@@ -633,7 +634,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Build
+     * Create build
      *
      * Create a new build for an Appwrite Function deployment. This endpoint can
      * be used to retry a failed build.
@@ -668,6 +669,9 @@ class Functions extends Service {
     /**
      * Download Deployment
      *
+     * Get a Deployment's contents by its unique ID. This endpoint supports range
+     * requests for partial or streaming file download.
+     *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
@@ -691,7 +695,7 @@ class Functions extends Service {
     }
 
     /**
-     * List Executions
+     * List executions
      *
      * Get a list of all the current user function execution logs. You can use the
      * query params to filter your results.
@@ -724,7 +728,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Execution
+     * Create execution
      *
      * Trigger a function execution. The returned object will return you the
      * current execution status. You can ping the `Get Execution` endpoint to get
@@ -774,7 +778,7 @@ class Functions extends Service {
     }
 
     /**
-     * Get Execution
+     * Get execution
      *
      * Get a function execution log by its unique ID.
      *
@@ -801,7 +805,7 @@ class Functions extends Service {
     }
 
     /**
-     * List Variables
+     * List variables
      *
      * Get a list of all variables of a specific function.
      *
@@ -823,7 +827,7 @@ class Functions extends Service {
     }
 
     /**
-     * Create Variable
+     * Create variable
      *
      * Create a new function environment variable. These variables can be accessed
      * in the function at runtime as environment variables.
@@ -864,7 +868,7 @@ class Functions extends Service {
     }
 
     /**
-     * Get Variable
+     * Get variable
      *
      * Get a variable by its unique ID.
      *
@@ -891,7 +895,7 @@ class Functions extends Service {
     }
 
     /**
-     * Update Variable
+     * Update variable
      *
      * Update variable by its unique ID.
      *
@@ -932,7 +936,7 @@ class Functions extends Service {
     }
 
     /**
-     * Delete Variable
+     * Delete variable
      *
      * Delete a variable by its unique ID.
      *

package/lib/services/graphql.js

@@ -15,7 +15,7 @@ class Graphql extends Service {
 
 
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *
@@ -42,7 +42,7 @@ class Graphql extends Service {
     }
 
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *