Skip to content
Closed
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
11 changes: 10 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Change Log

## 20.1.1

* Update SDK as per latest server specs, these include -
* Updates to Runtime enums
* `Output` is now renamed to `ImageFormat` - Note that this is a breaking change
* Introduces Backups module for managing Database backups
* Introduces Organization module

## 20.1.0

* Added ability to create columns and indexes synchronously while creating a table

## 20.0.0

* Rename `VCSDeploymentType` enum to `VCSReferenceType`
* Change `create_template_deployment` method signature: replace `version` parameter with `type` (TemplateReferenceType) and `reference` parameters
* Change `create_template_deployment` method signature: replace `version` parameter with `type` (TemplateReferenceType)
and `reference` parameters
* Add `get_screenshot` method to `Avatars` service
* Add `Theme`, `Timezone` and `Output` enums

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.
Copyright (c) 2026 Appwrite (https://appwrite.io) and individual contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Appwrite Ruby SDK

![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.8.0-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.8.1-blue.svg?style=flat-square)
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
[![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-ruby/releases).**
**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).**

Appwrite is an open-source backend as a service server that abstract and simplify 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 Ruby 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)
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 Ruby 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)

![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)

Expand Down
4 changes: 2 additions & 2 deletions appwrite.gemspec
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Gem::Specification.new do |spec|

spec.name = 'appwrite'
spec.version = '20.1.0'
spec.version = '20.1.1'
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.summary = 'Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API'
spec.author = 'Appwrite Team'
spec.homepage = 'https://appwrite.io/support'
spec.email = 'team@appwrite.io'
Expand Down
4 changes: 3 additions & 1 deletion docs/examples/account/create-jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ client = Client.new

account = Account.new(client)

result = account.create_jwt()
result = account.create_jwt(
duration: 0 # optional
)
2 changes: 1 addition & 1 deletion docs/examples/avatars/get-screenshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ result = avatars.get_screenshot(
width: 800, # optional
height: 600, # optional
quality: 85, # optional
output: Output::JPG # optional
output: ImageFormat::JPG # optional
)
15 changes: 15 additions & 0 deletions docs/examples/backups/create-archive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
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

backups = Backups.new(client)

result = backups.create_archive(
services: [],
resource_id: '<RESOURCE_ID>' # optional
)
20 changes: 20 additions & 0 deletions docs/examples/backups/create-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
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

backups = Backups.new(client)

result = backups.create_policy(
policy_id: '<POLICY_ID>',
services: [],
retention: 1,
schedule: '',
name: '<NAME>', # optional
resource_id: '<RESOURCE_ID>', # optional
enabled: false # optional
)
17 changes: 17 additions & 0 deletions docs/examples/backups/create-restoration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
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

backups = Backups.new(client)

result = backups.create_restoration(
archive_id: '<ARCHIVE_ID>',
services: [],
new_resource_id: '<NEW_RESOURCE_ID>', # optional
new_resource_name: '<NEW_RESOURCE_NAME>' # optional
)
14 changes: 14 additions & 0 deletions docs/examples/backups/delete-archive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.delete_archive(
archive_id: '<ARCHIVE_ID>'
)
14 changes: 14 additions & 0 deletions docs/examples/backups/delete-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.delete_policy(
policy_id: '<POLICY_ID>'
)
14 changes: 14 additions & 0 deletions docs/examples/backups/get-archive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.get_archive(
archive_id: '<ARCHIVE_ID>'
)
14 changes: 14 additions & 0 deletions docs/examples/backups/get-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.get_policy(
policy_id: '<POLICY_ID>'
)
14 changes: 14 additions & 0 deletions docs/examples/backups/get-restoration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.get_restoration(
restoration_id: '<RESTORATION_ID>'
)
14 changes: 14 additions & 0 deletions docs/examples/backups/list-archives.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.list_archives(
queries: [] # optional
)
14 changes: 14 additions & 0 deletions docs/examples/backups/list-policies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.list_policies(
queries: [] # optional
)
14 changes: 14 additions & 0 deletions docs/examples/backups/list-restorations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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

backups = Backups.new(client)

result = backups.list_restorations(
queries: [] # optional
)
18 changes: 18 additions & 0 deletions docs/examples/backups/update-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
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

backups = Backups.new(client)

result = backups.update_policy(
policy_id: '<POLICY_ID>',
name: '<NAME>', # optional
retention: 1, # optional
schedule: '', # optional
enabled: false # optional
)
8 changes: 7 additions & 1 deletion docs/examples/databases/update-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ result = databases.update_document(
database_id: '<DATABASE_ID>',
collection_id: '<COLLECTION_ID>',
document_id: '<DOCUMENT_ID>',
data: {}, # optional
data: {
"username" => "walter.obrien",
"email" => "walter.obrien@example.com",
"fullName" => "Walter O'Brien",
"age" => 33,
"isAdmin" => false
}, # optional
permissions: [Permission.read(Role.any())], # optional
transaction_id: '<TRANSACTION_ID>' # optional
)
8 changes: 7 additions & 1 deletion docs/examples/databases/update-documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@ databases = Databases.new(client)
result = databases.update_documents(
database_id: '<DATABASE_ID>',
collection_id: '<COLLECTION_ID>',
data: {}, # optional
data: {
"username" => "walter.obrien",
"email" => "walter.obrien@example.com",
"fullName" => "Walter O'Brien",
"age" => 33,
"isAdmin" => false
}, # optional
queries: [], # optional
transaction_id: '<TRANSACTION_ID>' # optional
)
8 changes: 7 additions & 1 deletion docs/examples/databases/upsert-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ result = databases.upsert_document(
database_id: '<DATABASE_ID>',
collection_id: '<COLLECTION_ID>',
document_id: '<DOCUMENT_ID>',
data: {},
data: {
"username" => "walter.obrien",
"email" => "walter.obrien@example.com",
"fullName" => "Walter O'Brien",
"age" => 30,
"isAdmin" => false
}, # optional
permissions: [Permission.read(Role.any())], # optional
transaction_id: '<TRANSACTION_ID>' # optional
)
14 changes: 14 additions & 0 deletions docs/examples/organizations/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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_session('') # The user session to authenticate with

organizations = Organizations.new(client)

result = organizations.delete(
organization_id: '<ORGANIZATION_ID>'
)
14 changes: 14 additions & 0 deletions docs/examples/organizations/estimation-delete-organization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
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_session('') # The user session to authenticate with

organizations = Organizations.new(client)

result = organizations.estimation_delete_organization(
organization_id: '<ORGANIZATION_ID>'
)
8 changes: 7 additions & 1 deletion docs/examples/tablesdb/update-row.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ result = tables_db.update_row(
database_id: '<DATABASE_ID>',
table_id: '<TABLE_ID>',
row_id: '<ROW_ID>',
data: {}, # optional
data: {
"username" => "walter.obrien",
"email" => "walter.obrien@example.com",
"fullName" => "Walter O'Brien",
"age" => 33,
"isAdmin" => false
}, # optional
permissions: [Permission.read(Role.any())], # optional
transaction_id: '<TRANSACTION_ID>' # optional
)
8 changes: 7 additions & 1 deletion docs/examples/tablesdb/update-rows.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@ tables_db = TablesDB.new(client)
result = tables_db.update_rows(
database_id: '<DATABASE_ID>',
table_id: '<TABLE_ID>',
data: {}, # optional
data: {
"username" => "walter.obrien",
"email" => "walter.obrien@example.com",
"fullName" => "Walter O'Brien",
"age" => 33,
"isAdmin" => false
}, # optional
queries: [], # optional
transaction_id: '<TRANSACTION_ID>' # optional
)
8 changes: 7 additions & 1 deletion docs/examples/tablesdb/upsert-row.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ result = tables_db.upsert_row(
database_id: '<DATABASE_ID>',
table_id: '<TABLE_ID>',
row_id: '<ROW_ID>',
data: {}, # optional
data: {
"username" => "walter.obrien",
"email" => "walter.obrien@example.com",
"fullName" => "Walter O'Brien",
"age" => 33,
"isAdmin" => false
}, # optional
permissions: [Permission.read(Role.any())], # optional
transaction_id: '<TRANSACTION_ID>' # optional
)
Loading