Skip to content

Commit aade39b

Browse files
committed
Add support for 1.7
1 parent c863c42 commit aade39b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+2231
-150
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Appwrite Node.js SDK
22

33
![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?style=flat-square)
4-
![Version](https://img.shields.io/badge/api%20version-1.6.2-blue.svg?style=flat-square)
4+
![Version](https://img.shields.io/badge/api%20version-1.7.0-blue.svg?style=flat-square)
55
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
66
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
77
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
88

9-
**This SDK is compatible with Appwrite server version 1.6.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
9+
**This SDK is compatible with Appwrite server version 1.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
1010

1111
> This is the Node.js SDK for integrating with Appwrite from your Node.js server-side code.
1212
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/avatars/get-browser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ const result = await avatars.getBrowser(
1111
sdk.Browser.AvantBrowser, // code
1212
0, // width (optional)
1313
0, // height (optional)
14-
0 // quality (optional)
14+
-1 // quality (optional)
1515
);

docs/examples/avatars/get-credit-card.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ const result = await avatars.getCreditCard(
1111
sdk.CreditCard.AmericanExpress, // code
1212
0, // width (optional)
1313
0, // height (optional)
14-
0 // quality (optional)
14+
-1 // quality (optional)
1515
);

docs/examples/avatars/get-flag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ const result = await avatars.getFlag(
1111
sdk.Flag.Afghanistan, // code
1212
0, // width (optional)
1313
0, // height (optional)
14-
0 // quality (optional)
14+
-1 // quality (optional)
1515
);

docs/examples/databases/create-document.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ const sdk = require('node-appwrite');
22

33
const client = new sdk.Client()
44
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5-
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6-
.setSession(''); // The user session to authenticate with
5+
.setSession('') // The user session to authenticate with
6+
.setKey('<YOUR_API_KEY>') // Your secret API key
7+
.setJWT('<YOUR_JWT>'); // Your secret JSON Web Token
78

89
const databases = new sdk.Databases(client);
910

docs/examples/databases/create-documents.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ const sdk = require('node-appwrite');
22

33
const client = new sdk.Client()
44
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5-
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6-
.setSession(''); // The user session to authenticate with
5+
.setKey('<YOUR_API_KEY>'); // Your secret API key
76

87
const databases = new sdk.Databases(client);
98

docs/examples/databases/create-index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@ const result = await databases.createIndex(
1313
'', // key
1414
sdk.IndexType.Key, // type
1515
[], // attributes
16-
[] // orders (optional)
16+
[], // orders (optional)
17+
[] // lengths (optional)
1718
);

docs/examples/functions/create-build.md renamed to docs/examples/functions/create-duplicate-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const client = new sdk.Client()
77

88
const functions = new sdk.Functions(client);
99

10-
const result = await functions.createBuild(
10+
const result = await functions.createDuplicateDeployment(
1111
'<FUNCTION_ID>', // functionId
1212
'<DEPLOYMENT_ID>', // deploymentId
1313
'<BUILD_ID>' // buildId (optional)
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const functions = new sdk.Functions(client);
9+
10+
const result = await functions.createTemplateDeployment(
11+
'<FUNCTION_ID>', // functionId
12+
'<REPOSITORY>', // repository
13+
'<OWNER>', // owner
14+
'<ROOT_DIRECTORY>', // rootDirectory
15+
'<VERSION>', // version
16+
false // activate (optional)
17+
);

docs/examples/functions/create-variable.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ const functions = new sdk.Functions(client);
1010
const result = await functions.createVariable(
1111
'<FUNCTION_ID>', // functionId
1212
'<KEY>', // key
13-
'<VALUE>' // value
13+
'<VALUE>', // value
14+
false // secret (optional)
1415
);
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const functions = new sdk.Functions(client);
9+
10+
const result = await functions.createVcsDeployment(
11+
'<FUNCTION_ID>', // functionId
12+
sdk.VCSDeploymentType.Branch, // type
13+
'<REFERENCE>', // reference
14+
false // activate (optional)
15+
);

docs/examples/functions/create.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,5 @@ const result = await functions.create(
2525
'<PROVIDER_BRANCH>', // providerBranch (optional)
2626
false, // providerSilentMode (optional)
2727
'<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional)
28-
'<TEMPLATE_REPOSITORY>', // templateRepository (optional)
29-
'<TEMPLATE_OWNER>', // templateOwner (optional)
30-
'<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional)
31-
'<TEMPLATE_VERSION>', // templateVersion (optional)
3228
'' // specification (optional)
3329
);

docs/examples/functions/get-deployment-download.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ const functions = new sdk.Functions(client);
99

1010
const result = await functions.getDeploymentDownload(
1111
'<FUNCTION_ID>', // functionId
12-
'<DEPLOYMENT_ID>' // deploymentId
12+
'<DEPLOYMENT_ID>', // deploymentId
13+
sdk.DeploymentDownloadType.Source // type (optional)
1314
);

docs/examples/functions/list-executions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,5 @@ const functions = new sdk.Functions(client);
99

1010
const result = await functions.listExecutions(
1111
'<FUNCTION_ID>', // functionId
12-
[], // queries (optional)
13-
'<SEARCH>' // search (optional)
12+
[] // queries (optional)
1413
);

docs/examples/functions/update-deployment-build.md renamed to docs/examples/functions/update-deployment-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const client = new sdk.Client()
77

88
const functions = new sdk.Functions(client);
99

10-
const result = await functions.updateDeploymentBuild(
10+
const result = await functions.updateDeploymentStatus(
1111
'<FUNCTION_ID>', // functionId
1212
'<DEPLOYMENT_ID>' // deploymentId
1313
);

docs/examples/functions/update-deployment.md renamed to docs/examples/functions/update-function-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const client = new sdk.Client()
77

88
const functions = new sdk.Functions(client);
99

10-
const result = await functions.updateDeployment(
10+
const result = await functions.updateFunctionDeployment(
1111
'<FUNCTION_ID>', // functionId
1212
'<DEPLOYMENT_ID>' // deploymentId
1313
);

docs/examples/functions/update-variable.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@ const result = await functions.updateVariable(
1111
'<FUNCTION_ID>', // functionId
1212
'<VARIABLE_ID>', // variableId
1313
'<KEY>', // key
14-
'<VALUE>' // value (optional)
14+
'<VALUE>', // value (optional)
15+
false // secret (optional)
1516
);
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
const sdk = require('node-appwrite');
2+
const fs = require('fs');
3+
4+
const client = new sdk.Client()
5+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
6+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
7+
.setKey('<YOUR_API_KEY>'); // Your secret API key
8+
9+
const sites = new sdk.Sites(client);
10+
11+
const result = await sites.createDeployment(
12+
'<SITE_ID>', // siteId
13+
InputFile.fromPath('/path/to/file', 'filename'), // code
14+
false, // activate
15+
'<INSTALL_COMMAND>', // installCommand (optional)
16+
'<BUILD_COMMAND>', // buildCommand (optional)
17+
'<OUTPUT_DIRECTORY>' // outputDirectory (optional)
18+
);
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.createDuplicateDeployment(
11+
'<SITE_ID>', // siteId
12+
'<DEPLOYMENT_ID>' // deploymentId
13+
);
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.createTemplateDeployment(
11+
'<SITE_ID>', // siteId
12+
'<REPOSITORY>', // repository
13+
'<OWNER>', // owner
14+
'<ROOT_DIRECTORY>', // rootDirectory
15+
'<VERSION>', // version
16+
false // activate (optional)
17+
);
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.createVariable(
11+
'<SITE_ID>', // siteId
12+
'<KEY>', // key
13+
'<VALUE>', // value
14+
false // secret (optional)
15+
);
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.createVcsDeployment(
11+
'<SITE_ID>', // siteId
12+
sdk.VCSDeploymentType.Branch, // type
13+
'<REFERENCE>', // reference
14+
false // activate (optional)
15+
);

docs/examples/sites/create.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.create(
11+
'<SITE_ID>', // siteId
12+
'<NAME>', // name
13+
sdk..Analog, // framework
14+
sdk..Node145, // buildRuntime
15+
false, // enabled (optional)
16+
false, // logging (optional)
17+
1, // timeout (optional)
18+
'<INSTALL_COMMAND>', // installCommand (optional)
19+
'<BUILD_COMMAND>', // buildCommand (optional)
20+
'<OUTPUT_DIRECTORY>', // outputDirectory (optional)
21+
sdk..Static, // adapter (optional)
22+
'<INSTALLATION_ID>', // installationId (optional)
23+
'<FALLBACK_FILE>', // fallbackFile (optional)
24+
'<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)
25+
'<PROVIDER_BRANCH>', // providerBranch (optional)
26+
false, // providerSilentMode (optional)
27+
'<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional)
28+
'' // specification (optional)
29+
);
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.deleteDeployment(
11+
'<SITE_ID>', // siteId
12+
'<DEPLOYMENT_ID>' // deploymentId
13+
);

docs/examples/sites/delete-log.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.deleteLog(
11+
'<SITE_ID>', // siteId
12+
'<LOG_ID>' // logId
13+
);
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.deleteVariable(
11+
'<SITE_ID>', // siteId
12+
'<VARIABLE_ID>' // variableId
13+
);

docs/examples/sites/delete.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.delete(
11+
'<SITE_ID>' // siteId
12+
);
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.getDeploymentDownload(
11+
'<SITE_ID>', // siteId
12+
'<DEPLOYMENT_ID>', // deploymentId
13+
sdk.DeploymentDownloadType.Source // type (optional)
14+
);

docs/examples/sites/get-deployment.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.getDeployment(
11+
'<SITE_ID>', // siteId
12+
'<DEPLOYMENT_ID>' // deploymentId
13+
);

docs/examples/sites/get-log.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.getLog(
11+
'<SITE_ID>', // siteId
12+
'<LOG_ID>' // logId
13+
);

docs/examples/sites/get-variable.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const sdk = require('node-appwrite');
2+
3+
const client = new sdk.Client()
4+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
5+
.setProject('<YOUR_PROJECT_ID>') // Your project ID
6+
.setKey('<YOUR_API_KEY>'); // Your secret API key
7+
8+
const sites = new sdk.Sites(client);
9+
10+
const result = await sites.getVariable(
11+
'<SITE_ID>', // siteId
12+
'<VARIABLE_ID>' // variableId
13+
);

0 commit comments

Comments
 (0)