chore: add setDevkey and upsertDocument methods

Author: ChiragAgg5k

docs/examples/databases/create-documents.md renamed to docs/examples/databases/upsert-document.md

@@ -2,14 +2,16 @@ import { Client, Databases } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setKey(''); // 
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
-const result = await databases.createDocuments(
+const result = await databases.upsertDocument(
     '<DATABASE_ID>', // databaseId
     '<COLLECTION_ID>', // collectionId
-    [] // documents
+    '<DOCUMENT_ID>', // documentId
+    {}, // data
+    ["read("any")"] // permissions (optional)
 );
 
 console.log(result);

src/client.ts

@@ -307,6 +307,7 @@ class Client {
         jwt: '',
         locale: '',
         session: '',
+        devkey: '',
     };
     /**
      * Custom headers for API requests.
@@ -409,6 +410,20 @@ class Client {
         this.config.session = value;
         return this;
     }
+    /**
+     * Set DevKey
+     *
+     * Your secret dev API key
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setDevKey(value: string): this {
+        this.headers['X-Appwrite-Dev-Key'] = value;
+        this.config.devkey = value;
+        return this;
+    }
 
     private realtime: Realtime = {
         socket: undefined,

src/services/databases.ts

@@ -91,53 +91,54 @@ export class Databases {
         );
     }
     /**
-     * Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
+     * Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
      *
      * @param {string} databaseId
      * @param {string} collectionId
-     * @param {object[]} documents
+     * @param {string} documentId
+     * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise<Models.DocumentList<Document>>}
+     * @returns {Promise<Document>}
      */
-    createDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>> {
+    getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }
         if (typeof collectionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "collectionId"');
         }
-        if (typeof documents === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "documents"');
+        if (typeof documentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "documentId"');
         }
-        const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId);
+        const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
         const payload: Payload = {};
-        if (typeof documents !== 'undefined') {
-            payload['documents'] = documents;
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
         }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
-            'post',
+            'get',
             uri,
             apiHeaders,
             payload
         );
     }
     /**
-     * Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
+     * Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} documentId
-     * @param {string[]} queries
+     * @param {object} data
+     * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise<Document>}
      */
-    getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document> {
+    upsertDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }
@@ -147,18 +148,25 @@ export class Databases {
         if (typeof documentId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "documentId"');
         }
+        if (typeof data === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "data"');
+        }
         const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
         const payload: Payload = {};
-        if (typeof queries !== 'undefined') {
-            payload['queries'] = queries;
+        if (typeof data !== 'undefined') {
+            payload['data'] = data;
+        }
+        if (typeof permissions !== 'undefined') {
+            payload['permissions'] = permissions;
         }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
         }
 
         return this.client.call(
-            'get',
+            'put',
             uri,
             apiHeaders,
             payload