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

## 19.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 `create_resend_provider` and `update_resend_provider` methods to `Messaging` service

## 19.2.1

* Add transaction support for Databases and TablesDB
Expand Down
2 changes: 1 addition & 1 deletion appwrite.gemspec
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Gem::Specification.new do |spec|

spec.name = 'appwrite'
spec.version = '19.2.1'
spec.version = '19.3.0'
spec.license = 'BSD-3-Clause'
spec.summary = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API'
spec.author = 'Appwrite Team'
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 @@ -10,5 +10,6 @@ client = Client.new
account = Account.new(client)

result = account.list_identities(
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 @@ -10,5 +10,6 @@ client = Client.new
account = Account.new(client)

result = account.list_logs(
queries: [] # optional
queries: [], # optional
total: false # optional
)
4 changes: 3 additions & 1 deletion docs/examples/databases/create-collection.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -13,7 +15,7 @@ result = databases.create_collection(
database_id: '<DATABASE_ID>',
collection_id: '<COLLECTION_ID>',
name: '<NAME>',
permissions: ["read("any")"], # optional
permissions: [Permission.read(Role.any())], # optional
document_security: false, # optional
enabled: false # optional
)
4 changes: 3 additions & 1 deletion docs/examples/databases/create-document.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -20,6 +22,6 @@ result = databases.create_document(
"age" => 30,
"isAdmin" => false
},
permissions: ["read("any")"], # optional
permissions: [Permission.read(Role.any())], # optional
transaction_id: '<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 @@ -12,5 +12,6 @@ databases = Databases.new(client)
result = databases.list_attributes(
database_id: '<DATABASE_ID>',
collection_id: '<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 @@ -12,5 +12,6 @@ databases = Databases.new(client)
result = databases.list_collections(
database_id: '<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 @@ -13,5 +13,6 @@ result = databases.list_documents(
database_id: '<DATABASE_ID>',
collection_id: '<COLLECTION_ID>',
queries: [], # optional
transaction_id: '<TRANSACTION_ID>' # optional
transaction_id: '<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 @@ -12,5 +12,6 @@ databases = Databases.new(client)
result = databases.list_indexes(
database_id: '<DATABASE_ID>',
collection_id: '<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 @@ -11,5 +11,6 @@ databases = Databases.new(client)

result = databases.list(
queries: [], # optional
search: '<SEARCH>' # optional
search: '<SEARCH>', # optional
total: false # optional
)
4 changes: 3 additions & 1 deletion docs/examples/databases/update-collection.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -13,7 +15,7 @@ result = databases.update_collection(
database_id: '<DATABASE_ID>',
collection_id: '<COLLECTION_ID>',
name: '<NAME>',
permissions: ["read("any")"], # optional
permissions: [Permission.read(Role.any())], # optional
document_security: false, # optional
enabled: false # optional
)
4 changes: 3 additions & 1 deletion docs/examples/databases/update-document.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -14,6 +16,6 @@ result = databases.update_document(
collection_id: '<COLLECTION_ID>',
document_id: '<DOCUMENT_ID>',
data: {}, # optional
permissions: ["read("any")"], # optional
permissions: [Permission.read(Role.any())], # optional
transaction_id: '<TRANSACTION_ID>' # optional
)
4 changes: 3 additions & 1 deletion docs/examples/databases/upsert-document.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -14,6 +16,6 @@ result = databases.upsert_document(
collection_id: '<COLLECTION_ID>',
document_id: '<DOCUMENT_ID>',
data: {},
permissions: ["read("any")"], # optional
permissions: [Permission.read(Role.any())], # optional
transaction_id: '<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 @@ -12,5 +12,6 @@ functions = Functions.new(client)
result = functions.list_deployments(
function_id: '<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 @@ -11,5 +11,6 @@ functions = Functions.new(client)

result = functions.list_executions(
function_id: '<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 @@ -11,5 +11,6 @@ functions = Functions.new(client)

result = functions.list(
queries: [], # optional
search: '<SEARCH>' # optional
search: '<SEARCH>', # optional
total: false # optional
)
21 changes: 21 additions & 0 deletions docs/examples/messaging/create-resend-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
require 'appwrite'

include Appwrite

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
.set_project('<YOUR_PROJECT_ID>') # Your project ID
.set_key('<YOUR_API_KEY>') # Your secret API key

messaging = Messaging.new(client)

result = messaging.create_resend_provider(
provider_id: '<PROVIDER_ID>',
name: '<NAME>',
api_key: '<API_KEY>', # optional
from_name: '<FROM_NAME>', # optional
from_email: 'email@example.com', # optional
reply_to_name: '<REPLY_TO_NAME>', # optional
reply_to_email: '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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_message_logs(
message_id: '<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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_messages(
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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_provider_logs(
provider_id: '<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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_providers(
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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_subscriber_logs(
subscriber_id: '<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 @@ -12,5 +12,6 @@ messaging = Messaging.new(client)
result = messaging.list_subscribers(
topic_id: '<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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_targets(
message_id: '<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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_topic_logs(
topic_id: '<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 @@ -11,5 +11,6 @@ messaging = Messaging.new(client)

result = messaging.list_topics(
queries: [], # optional
search: '<SEARCH>' # optional
search: '<SEARCH>', # optional
total: false # optional
)
21 changes: 21 additions & 0 deletions docs/examples/messaging/update-resend-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
require 'appwrite'

include Appwrite

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
.set_project('<YOUR_PROJECT_ID>') # Your project ID
.set_key('<YOUR_API_KEY>') # Your secret API key

messaging = Messaging.new(client)

result = messaging.update_resend_provider(
provider_id: '<PROVIDER_ID>',
name: '<NAME>', # optional
enabled: false, # optional
api_key: '<API_KEY>', # optional
from_name: '<FROM_NAME>', # optional
from_email: 'email@example.com', # optional
reply_to_name: '<REPLY_TO_NAME>', # optional
reply_to_email: '<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 @@ -12,5 +12,6 @@ sites = Sites.new(client)
result = sites.list_deployments(
site_id: '<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 @@ -11,5 +11,6 @@ sites = Sites.new(client)

result = sites.list_logs(
site_id: '<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 @@ -11,5 +11,6 @@ sites = Sites.new(client)

result = sites.list(
queries: [], # optional
search: '<SEARCH>' # optional
search: '<SEARCH>', # optional
total: false # optional
)
4 changes: 3 additions & 1 deletion docs/examples/storage/create-bucket.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -12,7 +14,7 @@ storage = Storage.new(client)
result = storage.create_bucket(
bucket_id: '<BUCKET_ID>',
name: '<NAME>',
permissions: ["read("any")"], # optional
permissions: [Permission.read(Role.any())], # optional
file_security: false, # optional
enabled: false, # optional
maximum_file_size: 1, # optional
Expand Down
4 changes: 3 additions & 1 deletion docs/examples/storage/create-file.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -13,5 +15,5 @@ result = storage.create_file(
bucket_id: '<BUCKET_ID>',
file_id: '<FILE_ID>',
file: InputFile.from_path('dir/file.png'),
permissions: ["read("any")"] # optional
permissions: [Permission.read(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 @@ -11,5 +11,6 @@ storage = Storage.new(client)

result = storage.list_buckets(
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 @@ -12,5 +12,6 @@ storage = Storage.new(client)
result = storage.list_files(
bucket_id: '<BUCKET_ID>',
queries: [], # optional
search: '<SEARCH>' # optional
search: '<SEARCH>', # optional
total: false # optional
)
4 changes: 3 additions & 1 deletion docs/examples/storage/update-bucket.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
require 'appwrite'

include Appwrite
include Appwrite::Permission
include Appwrite::Role

client = Client.new
.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
Expand All @@ -12,7 +14,7 @@ storage = Storage.new(client)
result = storage.update_bucket(
bucket_id: '<BUCKET_ID>',
name: '<NAME>',
permissions: ["read("any")"], # optional
permissions: [Permission.read(Role.any())], # optional
file_security: false, # optional
enabled: false, # optional
maximum_file_size: 1, # optional
Expand Down
Loading