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

## 20.3.0

* Add `total` parameter to list queries allowing skipping counting rows in a table for improved performance
* Add `Operator` class for atomic modification of rows via update, bulk update, upsert, and bulk upsert operations
* Add `createResendProvider` and `updateResendProvider` methods to `Messaging` service

## 20.2.1

* Add transaction support for Databases and TablesDB
Expand Down
3 changes: 2 additions & 1 deletion docs/examples/account/list-identities.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.listIdentities({
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/account/list-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.listLogs({
queries: [] // optional
queries: [], // optional
total: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/databases/create-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const result = await databases.createCollection({
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
name: '<NAME>',
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
documentSecurity: false, // optional
enabled: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/databases/create-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ const result = await databases.createDocument({
"age": 30,
"isAdmin": false
},
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
transactionId: '<TRANSACTION_ID>' // optional
});
3 changes: 2 additions & 1 deletion docs/examples/databases/list-attributes.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.listAttributes({
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/databases/list-collections.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.listCollections({
databaseId: '<DATABASE_ID>',
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/databases/list-documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ const result = await databases.listDocuments({
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
queries: [], // optional
transactionId: '<TRANSACTION_ID>' // optional
transactionId: '<TRANSACTION_ID>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/databases/list-indexes.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.listIndexes({
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/databases/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const databases = new sdk.Databases(client);

const result = await databases.list({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/databases/update-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const result = await databases.updateCollection({
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
name: '<NAME>',
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
documentSecurity: false, // optional
enabled: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/databases/update-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ const result = await databases.updateDocument({
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
data: {}, // optional
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
transactionId: '<TRANSACTION_ID>' // optional
});
2 changes: 1 addition & 1 deletion docs/examples/databases/upsert-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ const result = await databases.upsertDocument({
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
data: {},
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
transactionId: '<TRANSACTION_ID>' // optional
});
3 changes: 2 additions & 1 deletion docs/examples/functions/list-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const functions = new sdk.Functions(client);
const result = await functions.listDeployments({
functionId: '<FUNCTION_ID>',
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/functions/list-executions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const functions = new sdk.Functions(client);

const result = await functions.listExecutions({
functionId: '<FUNCTION_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/functions/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const functions = new sdk.Functions(client);

const result = await functions.list({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
19 changes: 19 additions & 0 deletions docs/examples/messaging/create-resend-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
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 messaging = new sdk.Messaging(client);

const result = await messaging.createResendProvider({
providerId: '<PROVIDER_ID>',
name: '<NAME>',
apiKey: '<API_KEY>', // optional
fromName: '<FROM_NAME>', // optional
fromEmail: 'email@example.com', // optional
replyToName: '<REPLY_TO_NAME>', // optional
replyToEmail: 'email@example.com', // optional
enabled: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-message-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listMessageLogs({
messageId: '<MESSAGE_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listMessages({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-provider-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listProviderLogs({
providerId: '<PROVIDER_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listProviders({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-subscriber-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listSubscriberLogs({
subscriberId: '<SUBSCRIBER_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-subscribers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const messaging = new sdk.Messaging(client);
const result = await messaging.listSubscribers({
topicId: '<TOPIC_ID>',
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listTargets({
messageId: '<MESSAGE_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-topic-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listTopicLogs({
topicId: '<TOPIC_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/messaging/list-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const messaging = new sdk.Messaging(client);

const result = await messaging.listTopics({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
19 changes: 19 additions & 0 deletions docs/examples/messaging/update-resend-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
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 messaging = new sdk.Messaging(client);

const result = await messaging.updateResendProvider({
providerId: '<PROVIDER_ID>',
name: '<NAME>', // optional
enabled: false, // optional
apiKey: '<API_KEY>', // optional
fromName: '<FROM_NAME>', // optional
fromEmail: 'email@example.com', // optional
replyToName: '<REPLY_TO_NAME>', // optional
replyToEmail: '<REPLY_TO_EMAIL>' // optional
});
3 changes: 2 additions & 1 deletion docs/examples/sites/list-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const sites = new sdk.Sites(client);
const result = await sites.listDeployments({
siteId: '<SITE_ID>',
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/sites/list-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const sites = new sdk.Sites(client);

const result = await sites.listLogs({
siteId: '<SITE_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/sites/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const sites = new sdk.Sites(client);

const result = await sites.list({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/storage/create-bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const storage = new sdk.Storage(client);
const result = await storage.createBucket({
bucketId: '<BUCKET_ID>',
name: '<NAME>',
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
fileSecurity: false, // optional
enabled: false, // optional
maximumFileSize: 1, // optional
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/storage/create-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ const result = await storage.createFile({
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
file: InputFile.fromPath('/path/to/file', 'filename'),
permissions: ["read("any")"] // optional
permissions: [sdk.Permission.read(sdk.Role.any())] // optional
});
3 changes: 2 additions & 1 deletion docs/examples/storage/list-buckets.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const storage = new sdk.Storage(client);

const result = await storage.listBuckets({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/storage/list-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const storage = new sdk.Storage(client);
const result = await storage.listFiles({
bucketId: '<BUCKET_ID>',
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/storage/update-bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const storage = new sdk.Storage(client);
const result = await storage.updateBucket({
bucketId: '<BUCKET_ID>',
name: '<NAME>',
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
fileSecurity: false, // optional
enabled: false, // optional
maximumFileSize: 1, // optional
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/storage/update-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ const result = await storage.updateFile({
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
name: '<NAME>', // optional
permissions: ["read("any")"] // optional
permissions: [sdk.Permission.read(sdk.Role.any())] // optional
});
2 changes: 1 addition & 1 deletion docs/examples/tablesdb/create-row.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ const result = await tablesDB.createRow({
"age": 30,
"isAdmin": false
},
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
transactionId: '<TRANSACTION_ID>' // optional
});
2 changes: 1 addition & 1 deletion docs/examples/tablesdb/create-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const result = await tablesDB.createTable({
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
name: '<NAME>',
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
rowSecurity: false, // optional
enabled: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/tablesdb/list-columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const tablesDB = new sdk.TablesDB(client);
const result = await tablesDB.listColumns({
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/tablesdb/list-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const tablesDB = new sdk.TablesDB(client);
const result = await tablesDB.listIndexes({
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
queries: [] // optional
queries: [], // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/tablesdb/list-rows.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ const result = await tablesDB.listRows({
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
queries: [], // optional
transactionId: '<TRANSACTION_ID>' // optional
transactionId: '<TRANSACTION_ID>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/tablesdb/list-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ const tablesDB = new sdk.TablesDB(client);
const result = await tablesDB.listTables({
databaseId: '<DATABASE_ID>',
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
3 changes: 2 additions & 1 deletion docs/examples/tablesdb/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ const tablesDB = new sdk.TablesDB(client);

const result = await tablesDB.list({
queries: [], // optional
search: '<SEARCH>' // optional
search: '<SEARCH>', // optional
total: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/tablesdb/update-row.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ const result = await tablesDB.updateRow({
tableId: '<TABLE_ID>',
rowId: '<ROW_ID>',
data: {}, // optional
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
transactionId: '<TRANSACTION_ID>' // optional
});
2 changes: 1 addition & 1 deletion docs/examples/tablesdb/update-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const result = await tablesDB.updateTable({
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
name: '<NAME>',
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
rowSecurity: false, // optional
enabled: false // optional
});
2 changes: 1 addition & 1 deletion docs/examples/tablesdb/upsert-row.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ const result = await tablesDB.upsertRow({
tableId: '<TABLE_ID>',
rowId: '<ROW_ID>',
data: {}, // optional
permissions: ["read("any")"], // optional
permissions: [sdk.Permission.read(sdk.Role.any())], // optional
transactionId: '<TRANSACTION_ID>' // optional
});
Loading