Merge pull request #145 from appwrite/dev

Author: abnegate

CHANGELOG.md

@@ -1,13 +1,24 @@
 # Change Log
 
-## 22.2.0
-
-* Added ttl option to listDocuments for cached responses
-* Added getConsolePausing health status endpoint in Health service
-* Added Health.getConsolePausing overloads (object and positional)
-* Added updateRelationshipAttribute for Databases to manage relationship attributes
-* Added console pausing example to health docs
-* Made activate optional in createDeployment object parameter
+## 23.0.0
+
+* [BREAKING] Changed `$sequence` type from `number` to `string` for `Row` and `Document` models
+* [BREAKING] Renamed `IndexType` enum: split into `DatabasesIndexType` (with new `Spatial` value) and `TablesDBIndexType`
+* [BREAKING] Replaced `specification` parameter with `buildSpecification` and `runtimeSpecification` in `Functions.create()`, `Functions.update()`, `Sites.create()`, `Sites.update()`
+* Added new `Project` service with full CRUD for project-level environment variables
+* Added new `Webhooks` service with full CRUD for project webhooks (including `updateSignature`)
+* Added `Users.updateImpersonator()` method for enabling/disabling user impersonation
+* Added impersonation support: `setImpersonateUserId()`, `setImpersonateUserEmail()`, `setImpersonateUserPhone()` on `Client`
+* Added `impersonator` and `impersonatorUserId` optional fields to `User` model
+* Added `deploymentRetention` parameter to Functions and Sites create/update
+* Added `startCommand` parameter to Sites create/update
+* Added `Webhook` and `WebhookList` models
+* Added `Documentsdb`, `Vectorsdb` values to `BackupServices` and `DatabaseType` enums
+* Added `WebhooksRead`, `WebhooksWrite`, `ProjectRead`, `ProjectWrite` scopes
+* Added custom `toString()` on response data using `JSONbig.stringify` for BigInt support
+* Removed `getQueueBillingProjectAggregation`, `getQueueBillingTeamAggregation`, `getQueuePriorityBuilds`, `getQueueRegionManager`, `getQueueThreats` from `Health` service
+* Updated `Log` model field descriptions to clarify impersonation behavior
+* Updated `X-Appwrite-Response-Format` header to `1.9.0`
 
 ## 22.1.2
 

README.md

@@ -1,12 +1,12 @@
 # Appwrite Node.js SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.8.1-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.9.0-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
+**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
 
  > This is the Node.js SDK for integrating with Appwrite from your Node.js server-side code.
                             If you're looking to integrate from the browser, you should check [appwrite/sdk-for-web](https://github.com/appwrite/sdk-for-web)

docs/examples/databases/create-index.md

@@ -12,7 +12,7 @@ const result = await databases.createIndex({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
     key: '',
-    type: sdk.IndexType.Key,
+    type: sdk.DatabasesIndexType.Key,
     attributes: [],
     orders: [sdk.OrderBy.Asc], // optional
     lengths: [] // optional

docs/examples/functions/create.md

@@ -26,6 +26,8 @@ const result = await functions.create({
     providerBranch: '<PROVIDER_BRANCH>', // optional
     providerSilentMode: false, // optional
     providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
-    specification: '' // optional
+    buildSpecification: '', // optional
+    runtimeSpecification: '', // optional
+    deploymentRetention: 0 // optional
 });
 ```

docs/examples/functions/update.md

@@ -26,6 +26,8 @@ const result = await functions.update({
     providerBranch: '<PROVIDER_BRANCH>', // optional
     providerSilentMode: false, // optional
     providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
-    specification: '' // optional
+    buildSpecification: '', // optional
+    runtimeSpecification: '', // optional
+    deploymentRetention: 0 // optional
 });
 ```

docs/examples/project/create-variable.md

@@ -0,0 +1,17 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.createVariable({
+    variableId: '<VARIABLE_ID>',
+    key: '<KEY>',
+    value: '<VALUE>',
+    secret: false // optional
+});
+```

docs/examples/project/delete-variable.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.deleteVariable({
+    variableId: '<VARIABLE_ID>'
+});
+```

docs/examples/project/get-variable.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.getVariable({
+    variableId: '<VARIABLE_ID>'
+});
+```

docs/examples/project/list-variables.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.listVariables({
+    queries: [], // optional
+    total: false // optional
+});
+```

docs/examples/project/update-variable.md

@@ -0,0 +1,17 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.updateVariable({
+    variableId: '<VARIABLE_ID>',
+    key: '<KEY>', // optional
+    value: '<VALUE>', // optional
+    secret: false // optional
+});
+```