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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log

## 21.1.0

* Add `queries` parameter to Realtime subscriptions for filtering events
* Fix `Roles` enum removed from Teams service; `roles` parameter now accepts `List<String>`
* Fix doc examples with proper formatting and syntax highlighting
Comment on lines +3 to +7
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Changelog entry wording on Line 6 is slightly misleading.

"Fix Roles enum removed" reads as if the removal itself is a bug fix, but removing an enum and changing the parameter type to List<String> is a breaking change. Consider rewording to clarify intent, e.g.:

Suggested wording
-* Fix `Roles` enum removed from Teams service; `roles` parameter now accepts `List<String>`
+* **Breaking**: Removed `Roles` enum from Teams service; `roles` parameter now accepts `List<String>`
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## 21.1.0
* Add `queries` parameter to Realtime subscriptions for filtering events
* Fix `Roles` enum removed from Teams service; `roles` parameter now accepts `List<String>`
* Fix doc examples with proper formatting and syntax highlighting
## 21.1.0
* Add `queries` parameter to Realtime subscriptions for filtering events
* **Breaking**: Removed `Roles` enum from Teams service; `roles` parameter now accepts `List<String>`
* Fix doc examples with proper formatting and syntax highlighting
🤖 Prompt for AI Agents
In `@CHANGELOG.md` around lines 3 - 7, Reword the changelog line about the Teams
service to clarify this is a breaking change: replace "Fix `Roles` enum removed
from Teams service; `roles` parameter now accepts `List<String>`" with wording
that states the `Roles` enum was removed and the `roles` parameter now accepts
`List<String>` as a breaking change (e.g., "Breaking change: `Roles` enum
removed from Teams service; `roles` parameter now accepts `List<String>` —
update callers to pass a list of strings"). Mention `Roles` and `roles`
explicitly so readers can find the affected API.


## 21.0.0

* Add array-based enum parameters (e.g., `permissions: List<BrowserPermission>`).
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![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-flutter/releases).**
**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-flutter/releases).**

Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Flutter SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)

Expand All @@ -19,7 +19,7 @@ Add this to your package's `pubspec.yaml` file:

```yml
dependencies:
appwrite: ^21.0.0
appwrite: ^21.1.0
```

You can install packages from the command line:
Expand Down
2 changes: 2 additions & 0 deletions docs/examples/account/create-anonymous-session.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -7,3 +8,4 @@ Client client = Client()
Account account = Account(client);

Session result = await account.createAnonymousSession();
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-email-password-session.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -10,3 +11,4 @@ Session result = await account.createEmailPasswordSession(
email: 'email@example.com',
password: 'password',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-email-token.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -11,3 +12,4 @@ Token result = await account.createEmailToken(
email: 'email@example.com',
phrase: false, // optional
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-email-verification.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -9,3 +10,4 @@ Account account = Account(client);
Token result = await account.createEmailVerification(
url: 'https://example.com',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-jwt.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -9,3 +10,4 @@ Account account = Account(client);
Jwt result = await account.createJWT(
duration: 0, // optional
);
```
16 changes: 16 additions & 0 deletions docs/examples/account/create-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```dart
import 'package:appwrite/appwrite.dart';
import 'package:appwrite/enums.dart' as enums;

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

Account account = Account(client);

Key result = await account.createKey(
name: '<NAME>',
scopes: [enums.Scopes.account],
expire: '', // optional
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Empty string for optional expire parameter is misleading.

Passing expire: '' suggests a valid value, but an empty string likely isn't meaningful for an expiration date. Consider either omitting the parameter entirely (since it's optional) or showing a placeholder like '2025-12-31T00:00:00.000+00:00'.

🤖 Prompt for AI Agents
In `@docs/examples/account/create-key.md` at line 14, The example sets expire: ''
which is misleading; update the example to either remove the expire property
entirely (since it's optional) or replace the empty string with a realistic ISO
timestamp placeholder like '2025-12-31T00:00:00.000+00:00' so the optional
parameter expire is shown correctly and clearly; change the expire line in the
create-key example accordingly.

);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-magic-url-token.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -12,3 +13,4 @@ Token result = await account.createMagicURLToken(
url: 'https://example.com', // optional
phrase: false, // optional
);
```
3 changes: 3 additions & 0 deletions docs/examples/account/create-mfa-authenticator.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
```dart
import 'package:appwrite/appwrite.dart';
import 'package:appwrite/enums.dart' as enums;

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -9,3 +11,4 @@ Account account = Account(client);
MfaType result = await account.createMFAAuthenticator(
type: enums.AuthenticatorType.totp,
);
```
3 changes: 3 additions & 0 deletions docs/examples/account/create-mfa-challenge.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
```dart
import 'package:appwrite/appwrite.dart';
import 'package:appwrite/enums.dart' as enums;

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -9,3 +11,4 @@ Account account = Account(client);
MfaChallenge result = await account.createMFAChallenge(
factor: enums.AuthenticationFactor.email,
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-mfa-recovery-codes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -7,3 +8,4 @@ Client client = Client()
Account account = Account(client);

MfaRecoveryCodes result = await account.createMFARecoveryCodes();
```
3 changes: 3 additions & 0 deletions docs/examples/account/create-o-auth-2-session.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
```dart
import 'package:appwrite/appwrite.dart';
import 'package:appwrite/enums.dart' as enums;

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -12,3 +14,4 @@ await account.createOAuth2Session(
failure: 'https://example.com', // optional
scopes: [], // optional
);
```
3 changes: 3 additions & 0 deletions docs/examples/account/create-o-auth-2-token.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
```dart
import 'package:appwrite/appwrite.dart';
import 'package:appwrite/enums.dart' as enums;

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -12,3 +14,4 @@ await account.createOAuth2Token(
failure: 'https://example.com', // optional
scopes: [], // optional
);
```
11 changes: 11 additions & 0 deletions docs/examples/account/create-payment-method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

Account account = Account(client);

PaymentMethod result = await account.createPaymentMethod();
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-phone-token.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -10,3 +11,4 @@ Token result = await account.createPhoneToken(
userId: '<USER_ID>',
phone: '+12065550100',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-phone-verification.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -7,3 +8,4 @@ Client client = Client()
Account account = Account(client);

Token result = await account.createPhoneVerification();
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-push-target.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -11,3 +12,4 @@ Target result = await account.createPushTarget(
identifier: '<IDENTIFIER>',
providerId: '<PROVIDER_ID>', // optional
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-recovery.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -10,3 +11,4 @@ Token result = await account.createRecovery(
email: 'email@example.com',
url: 'https://example.com',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-session.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -10,3 +11,4 @@ Session result = await account.createSession(
userId: '<USER_ID>',
secret: '<SECRET>',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create-verification.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -9,3 +10,4 @@ Account account = Account(client);
Token result = await account.createVerification(
url: 'https://example.com',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/create.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -12,3 +13,4 @@ User result = await account.create(
password: '',
name: '<NAME>', // optional
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/delete-identity.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -9,3 +10,4 @@ Account account = Account(client);
await account.deleteIdentity(
identityId: '<IDENTITY_ID>',
);
```
13 changes: 13 additions & 0 deletions docs/examples/account/delete-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

Account account = Account(client);

await account.deleteKey(
keyId: '<KEY_ID>',
);
```
3 changes: 3 additions & 0 deletions docs/examples/account/delete-mfa-authenticator.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
```dart
import 'package:appwrite/appwrite.dart';
import 'package:appwrite/enums.dart' as enums;

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
Expand All @@ -9,3 +11,4 @@ Account account = Account(client);
await account.deleteMFAAuthenticator(
type: enums.AuthenticatorType.totp,
);
```
13 changes: 13 additions & 0 deletions docs/examples/account/delete-payment-method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

Account account = Account(client);

await account.deletePaymentMethod(
paymentMethodId: '<PAYMENT_METHOD_ID>',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/delete-push-target.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';
Client client = Client()
Expand All @@ -9,3 +10,4 @@ Account account = Account(client);
await account.deletePushTarget(
targetId: '<TARGET_ID>',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/delete-session.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';
Client client = Client()
Expand All @@ -9,3 +10,4 @@ Account account = Account(client);
await account.deleteSession(
sessionId: '<SESSION_ID>',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/delete-sessions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -7,3 +8,4 @@ Client client = Client()
Account account = Account(client);

await account.deleteSessions();
```
13 changes: 13 additions & 0 deletions docs/examples/account/get-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

Account account = Account(client);

Key result = await account.getKey(
keyId: '<KEY_ID>',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/get-mfa-recovery-codes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -7,3 +8,4 @@ Client client = Client()
Account account = Account(client);

MfaRecoveryCodes result = await account.getMFARecoveryCodes();
```
13 changes: 13 additions & 0 deletions docs/examples/account/get-payment-method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

Account account = Account(client);

PaymentMethod result = await account.getPaymentMethod(
paymentMethodId: '<PAYMENT_METHOD_ID>',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/get-prefs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -7,3 +8,4 @@ Client client = Client()
Account account = Account(client);

Preferences result = await account.getPrefs();
```
2 changes: 2 additions & 0 deletions docs/examples/account/get-session.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -9,3 +10,4 @@ Account account = Account(client);
Session result = await account.getSession(
sessionId: '<SESSION_ID>',
);
```
2 changes: 2 additions & 0 deletions docs/examples/account/get.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```dart
import 'package:appwrite/appwrite.dart';

Client client = Client()
Expand All @@ -7,3 +8,4 @@ Client client = Client()
Account account = Account(client);

User result = await account.get();
```
Loading