Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Change Log

## 29.4.0

* Added: `domains` service to manage domains, DNS records, email presets, prices, transfer status and zones
* Added: `waf` service with bypass, challenge, deny, rate-limit and redirect rules
* Added: `account.createEmailVerificationOTP`, `updateEmailVerificationOTP`, `createRecoveryOTP` and `updateRecoveryOTP`
* Added: `account.createIdTokenSession` and `Identity.providerIdToken`
* Added: `oauth2.introspect`
* Added: project environments with `project.createEnvironment`, `getEnvironment`, `listEnvironments`, `updateEnvironment` and `deleteEnvironment`
* Added: `organization.createEphemeralProjectKey`, `listProjectKeys`, `getProjectKey`, `updateProjectKey` and `deleteProjectKey`
* Added: Kakao, TikTok and Webflow OAuth2 providers with `project.updateOAuth2Kakao`, `updateOAuth2TikTok` and `updateOAuth2Webflow`
* Added: optional `prompt` on the Auth0, Discord, GitHub, Microsoft, Okta, Salesforce and Zoho OAuth2 settings, and native client IDs on Apple and Google
* Added: `project.updatePasswordPwnedPolicy`, `project.updatePasswordRotationPolicy` and `User.passwordPwned`
* Added: `messaging.createAppwriteProvider` and `messaging.updateAppwriteProvider`
* Added: optional `replyToEmail` and `replyToName` on email messages, `channelId` on push messages, and `qos` and `expiry` on topics
* Added: `avatars.updatePhoto` and `avatars.deletePhoto`
* Added: optional `duration` on `account.createEmailPasswordSession`, `current` on `account.deleteSessions`, `membershipId` on `teams.createMembership` and `fingerprints` on Android platforms
* Added: optional `total` on the locale, transaction, runtime, specification and framework lists
* Added: `dart-3.13` and `flutter-3.47` runtimes, the `jaspr` framework, the `trigram` index type, `auto` image gravity, the `dedicatedDatabase` proxy rule resource type, OTP email templates and new key scopes
* Added: optional fields on `BillingPlan`, `DedicatedDatabase`, `DedicatedDatabaseSpecification`, `Project` and `Topic`, and `free` and `start` in `BillingPlanGroup`

## 29.3.1

* Fixed: added `ProjectAuthMethodId.Passkey`, so `project.updateAuthMethod` can enable passkeys
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/create-email-password-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ const account = new sdk.Account(client);
const result = await account.createEmailPasswordSession({
email: 'email@example.com',
password: 'password',
duration: 60, // optional
});
```
14 changes: 14 additions & 0 deletions docs/examples/account/create-email-verification-otp.md
Original file line number Diff line number Diff line change
@@ -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
.setSession(''); // The user session to authenticate with

const account = new sdk.Account(client);

const result = await account.createEmailVerificationOTP({
phrase: false, // optional
});
```
19 changes: 19 additions & 0 deletions docs/examples/account/create-id-token-session.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
```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
.setSession(''); // The user session to authenticate with

const account = new sdk.Account(client);

const result = await account.createIdTokenSession({
provider: sdk.IdTokenProvider.Apple,
idToken: '<ID_TOKEN>',
nonce: '<NONCE>', // optional
accessToken: '<ACCESS_TOKEN>', // optional
accessTokenExpiry: 0, // optional
name: '<NAME>', // optional
});
```
15 changes: 15 additions & 0 deletions docs/examples/account/create-recovery-otp.md
Original file line number Diff line number Diff line change
@@ -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
.setSession(''); // The user session to authenticate with

const account = new sdk.Account(client);

const result = await account.createRecoveryOTP({
email: 'email@example.com',
phrase: false, // optional
});
```
4 changes: 3 additions & 1 deletion docs/examples/account/delete-sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ const client = new sdk.Client()

const account = new sdk.Account(client);

const result = await account.deleteSessions();
const result = await account.deleteSessions({
current: false, // optional
});
```
4 changes: 3 additions & 1 deletion docs/examples/account/list-sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@ const client = new sdk.Client()

const account = new sdk.Account(client);

const result = await account.listSessions();
const result = await account.listSessions({
total: false, // optional
});
```
15 changes: 15 additions & 0 deletions docs/examples/account/update-email-verification-otp.md
Original file line number Diff line number Diff line change
@@ -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
.setSession(''); // The user session to authenticate with

const account = new sdk.Account(client);

const result = await account.updateEmailVerificationOTP({
userId: '<USER_ID>',
secret: '<SECRET>',
});
```
16 changes: 16 additions & 0 deletions docs/examples/account/update-recovery-otp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```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
.setSession(''); // The user session to authenticate with

const account = new sdk.Account(client);

const result = await account.updateRecoveryOTP({
userId: '<USER_ID>',
secret: '<SECRET>',
password: 'password',
});
```
12 changes: 12 additions & 0 deletions docs/examples/avatars/delete-photo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
```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
.setSession(''); // The user session to authenticate with

const avatars = new sdk.Avatars(client);

const result = await avatars.deletePhoto();
```
15 changes: 15 additions & 0 deletions docs/examples/avatars/update-photo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```javascript
const sdk = require('node-appwrite');
const { InputFile } = require('node-appwrite/file');

const client = new sdk.Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with

const avatars = new sdk.Avatars(client);

const result = await avatars.updatePhoto({
file: InputFile.fromPath('/path/to/file', 'filename'),
});
```
1 change: 1 addition & 0 deletions docs/examples/databases/list-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const databases = new sdk.Databases(client);

const result = await databases.listTransactions({
queries: [], // optional
total: false, // optional
});
```
1 change: 1 addition & 0 deletions docs/examples/documentsdb/list-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const documentsDB = new sdk.DocumentsDB(client);

const result = await documentsDB.listTransactions({
queries: [], // optional
total: false, // optional
});
```
14 changes: 14 additions & 0 deletions docs/examples/domains/create-preset-google-workspace.md
Original file line number Diff line number Diff line change
@@ -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 domains = new sdk.Domains(client);

const result = await domains.createPresetGoogleWorkspace({
domainId: '<DOMAIN_ID>',
});
```
14 changes: 14 additions & 0 deletions docs/examples/domains/create-preset-i-cloud.md
Original file line number Diff line number Diff line change
@@ -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 domains = new sdk.Domains(client);

const result = await domains.createPresetICloud({
domainId: '<DOMAIN_ID>',
});
```
14 changes: 14 additions & 0 deletions docs/examples/domains/create-preset-mailgun.md
Original file line number Diff line number Diff line change
@@ -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 domains = new sdk.Domains(client);

const result = await domains.createPresetMailgun({
domainId: '<DOMAIN_ID>',
});
```
14 changes: 14 additions & 0 deletions docs/examples/domains/create-preset-outlook.md
Original file line number Diff line number Diff line change
@@ -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 domains = new sdk.Domains(client);

const result = await domains.createPresetOutlook({
domainId: '<DOMAIN_ID>',
});
```
14 changes: 14 additions & 0 deletions docs/examples/domains/create-preset-proton-mail.md
Original file line number Diff line number Diff line change
@@ -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 domains = new sdk.Domains(client);

const result = await domains.createPresetProtonMail({
domainId: '<DOMAIN_ID>',
});
```
14 changes: 14 additions & 0 deletions docs/examples/domains/create-preset-zoho.md
Original file line number Diff line number Diff line change
@@ -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 domains = new sdk.Domains(client);

const result = await domains.createPresetZoho({
domainId: '<DOMAIN_ID>',
});
```
18 changes: 18 additions & 0 deletions docs/examples/domains/create-record-a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```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 domains = new sdk.Domains(client);

const result = await domains.createRecordA({
domainId: '<DOMAIN_ID>',
name: '',
value: '',
ttl: 1,
comment: '<COMMENT>', // optional
});
```
18 changes: 18 additions & 0 deletions docs/examples/domains/create-record-aaaa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```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 domains = new sdk.Domains(client);

const result = await domains.createRecordAAAA({
domainId: '<DOMAIN_ID>',
name: '',
value: '',
ttl: 1,
comment: '<COMMENT>', // optional
});
```
18 changes: 18 additions & 0 deletions docs/examples/domains/create-record-alias.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```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 domains = new sdk.Domains(client);

const result = await domains.createRecordAlias({
domainId: '<DOMAIN_ID>',
name: '',
value: '<VALUE>',
ttl: 1,
comment: '<COMMENT>', // optional
});
```
18 changes: 18 additions & 0 deletions docs/examples/domains/create-record-caa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```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 domains = new sdk.Domains(client);

const result = await domains.createRecordCAA({
domainId: '<DOMAIN_ID>',
name: '',
value: '',
ttl: 1,
comment: '<COMMENT>', // optional
});
```
18 changes: 18 additions & 0 deletions docs/examples/domains/create-record-cname.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```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 domains = new sdk.Domains(client);

const result = await domains.createRecordCNAME({
domainId: '<DOMAIN_ID>',
name: '',
value: '<VALUE>',
ttl: 1,
comment: '<COMMENT>', // optional
});
```
18 changes: 18 additions & 0 deletions docs/examples/domains/create-record-https.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```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 domains = new sdk.Domains(client);

const result = await domains.createRecordHTTPS({
domainId: '<DOMAIN_ID>',
name: '',
value: '<VALUE>',
ttl: 1,
comment: '<COMMENT>', // optional
});
```
Loading