Appwite 1.5 support

abnegate · abnegate · commit dc367f49dba7 · 2024-03-08T10:46:38.000+01:00
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 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](https://appwrite.io/images/github.png)
+![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
 
 ## Installation
 
diff --git a/appwrite.gemspec b/appwrite.gemspec
@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name = 'appwrite'
-  spec.version = '11.0.0-rc.6'
+  spec.version = '11.0.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'
diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md
@@ -10,6 +10,6 @@ client = Client.new
 
 account = Account.new(client)
 
-result = account.add_authenticator(
+result = account.create_mfa_authenticator(
     type: AuthenticatorType::TOTP
 )
diff --git a/docs/examples/account/create-mfa-challenge.md b/docs/examples/account/create-mfa-challenge.md
@@ -9,6 +9,6 @@ client = Client.new
 
 account = Account.new(client)
 
-result = account.create_challenge(
-    factor: AuthenticationFactor::TOTP
+result = account.create_mfa_challenge(
+    factor: AuthenticationFactor::EMAIL
 )
diff --git a/docs/examples/account/create-mfa-recovery-codes.md b/docs/examples/account/create-mfa-recovery-codes.md
@@ -0,0 +1,12 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_session('') # The user session to authenticate with
+
+account = Account.new(client)
+
+result = account.create_mfa_recovery_codes()
diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md
@@ -10,7 +10,7 @@ client = Client.new
 
 account = Account.new(client)
 
-result = account.delete_authenticator(
+result = account.delete_mfa_authenticator(
     type: AuthenticatorType::TOTP,
     otp: '<OTP>'
 )
diff --git a/docs/examples/account/get-mfa-recovery-codes.md b/docs/examples/account/get-mfa-recovery-codes.md
@@ -0,0 +1,12 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_session('') # The user session to authenticate with
+
+account = Account.new(client)
+
+result = account.get_mfa_recovery_codes()
diff --git a/docs/examples/account/list-mfa-factors.md b/docs/examples/account/list-mfa-factors.md
@@ -9,4 +9,4 @@ client = Client.new
 
 account = Account.new(client)
 
-result = account.list_factors()
+result = account.list_mfa_factors()
diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md
@@ -10,7 +10,7 @@ client = Client.new
 
 account = Account.new(client)
 
-result = account.verify_authenticator(
+result = account.update_mfa_authenticator(
     type: AuthenticatorType::TOTP,
     otp: '<OTP>'
 )
diff --git a/docs/examples/account/update-mfa-challenge.md b/docs/examples/account/update-mfa-challenge.md
@@ -9,7 +9,7 @@ client = Client.new
 
 account = Account.new(client)
 
-result = account.update_challenge(
+result = account.update_mfa_challenge(
     challenge_id: '<CHALLENGE_ID>',
     otp: '<OTP>'
 )
diff --git a/docs/examples/account/update-mfa-recovery-codes.md b/docs/examples/account/update-mfa-recovery-codes.md
@@ -0,0 +1,12 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_session('') # The user session to authenticate with
+
+account = Account.new(client)
+
+result = account.update_mfa_recovery_codes()
diff --git a/docs/examples/databases/create-relationship-attribute.md b/docs/examples/databases/create-relationship-attribute.md
@@ -14,7 +14,7 @@ result = databases.create_relationship_attribute(
     database_id: '<DATABASE_ID>',
     collection_id: '<COLLECTION_ID>',
     related_collection_id: '<RELATED_COLLECTION_ID>',
-    type: RelationshipType::ONE_TO_ONE,
+    type: RelationshipType::ONETOONE,
     two_way: false, # optional
     key: '', # optional
     two_way_key: '', # optional
diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md
@@ -13,7 +13,7 @@ functions = Functions.new(client)
 result = functions.create(
     function_id: '<FUNCTION_ID>',
     name: '<NAME>',
-    runtime: ::NODE-14.5,
+    runtime: ::NODE_14_5,
     execute: ["any"], # optional
     events: [], # optional
     schedule: '', # optional
diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md
@@ -12,7 +12,7 @@ functions = Functions.new(client)
 result = functions.update(
     function_id: '<FUNCTION_ID>',
     name: '<NAME>',
-    runtime: ::NODE-14.5, # optional
+    runtime: ::NODE_14_5, # optional
     execute: ["any"], # optional
     events: [], # optional
     schedule: '', # optional
diff --git a/docs/examples/health/get-failed-jobs.md b/docs/examples/health/get-failed-jobs.md
@@ -11,6 +11,6 @@ client = Client.new
 health = Health.new(client)
 
 result = health.get_failed_jobs(
-    name: ::V1-DATABASE,
+    name: ::V1_DATABASE,
     threshold: null # optional
 )
diff --git a/docs/examples/health/get-queue-usage.md b/docs/examples/health/get-queue-usage.md
@@ -0,0 +1,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+
+health = Health.new(client)
+
+result = health.get_queue_usage(
+    threshold: null # optional
+)
diff --git a/docs/examples/health/get-storage.md b/docs/examples/health/get-storage.md
@@ -0,0 +1,12 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+
+health = Health.new(client)
+
+result = health.get_storage()
diff --git a/docs/examples/users/create-mfa-recovery-codes.md b/docs/examples/users/create-mfa-recovery-codes.md
@@ -0,0 +1,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+
+users = Users.new(client)
+
+result = users.create_mfa_recovery_codes(
+    user_id: '<USER_ID>'
+)
diff --git a/docs/examples/users/delete-mfa-authenticator.md b/docs/examples/users/delete-mfa-authenticator.md
@@ -10,7 +10,7 @@ client = Client.new
 
 users = Users.new(client)
 
-result = users.delete_authenticator(
+result = users.delete_mfa_authenticator(
     user_id: '<USER_ID>',
     type: AuthenticatorType::TOTP
 )
diff --git a/docs/examples/users/get-mfa-recovery-codes.md b/docs/examples/users/get-mfa-recovery-codes.md
@@ -0,0 +1,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+
+users = Users.new(client)
+
+result = users.get_mfa_recovery_codes(
+    user_id: '<USER_ID>'
+)
diff --git a/docs/examples/users/list-mfa-factors.md b/docs/examples/users/list-mfa-factors.md
@@ -9,6 +9,6 @@ client = Client.new
 
 users = Users.new(client)
 
-result = users.list_factors(
+result = users.list_mfa_factors(
     user_id: '<USER_ID>'
 )
diff --git a/docs/examples/users/update-mfa-recovery-codes.md b/docs/examples/users/update-mfa-recovery-codes.md
@@ -0,0 +1,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+
+users = Users.new(client)
+
+result = users.update_mfa_recovery_codes(
+    user_id: '<USER_ID>'
+)
diff --git a/lib/appwrite.rb b/lib/appwrite.rb
@@ -92,6 +92,7 @@
 require_relative 'appwrite/models/health_time'
 require_relative 'appwrite/models/headers'
 require_relative 'appwrite/models/mfa_challenge'
+require_relative 'appwrite/models/mfa_recovery_codes'
 require_relative 'appwrite/models/mfa_type'
 require_relative 'appwrite/models/mfa_factors'
 require_relative 'appwrite/models/provider'
@@ -100,8 +101,8 @@
 require_relative 'appwrite/models/subscriber'
 require_relative 'appwrite/models/target'
 
-require_relative 'appwrite/enums/authentication_factor'
 require_relative 'appwrite/enums/authenticator_type'
+require_relative 'appwrite/enums/authentication_factor'
 require_relative 'appwrite/enums/o_auth_provider'
 require_relative 'appwrite/enums/browser'
 require_relative 'appwrite/enums/credit_card'
diff --git a/lib/appwrite/client.rb b/lib/appwrite/client.rb
@@ -15,7 +15,7 @@ def initialize
                 'x-sdk-name'=> 'Ruby',
                 'x-sdk-platform'=> 'server',
                 'x-sdk-language'=> 'ruby',
-                'x-sdk-version'=> '11.0.0-rc.6',                
+                'x-sdk-version'=> '11.0.0',                
                 'X-Appwrite-Response-Format' => '1.5.0'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'
diff --git a/lib/appwrite/enums/authentication_factor.rb b/lib/appwrite/enums/authentication_factor.rb
@@ -1,9 +1,10 @@
 module Appwrite
     module Enums
         module AuthenticationFactor
-            TOTP = 'totp'
-            PHONE = 'phone'
             EMAIL = 'email'
+            PHONE = 'phone'
+            TOTP = 'totp'
+            RECOVERYCODE = 'recoverycode'
         end
     end
 end
diff --git a/lib/appwrite/enums/flag.rb b/lib/appwrite/enums/flag.rb
@@ -34,7 +34,7 @@ module Flag
             SWITZERLAND = 'ch'
             CHILE = 'cl'
             CHINA = 'cn'
-            CôTE_D&#039;IVOIRE = 'ci'
+            COTE_DIVOIRE = 'ci'
             CAMEROON = 'cm'
             DEMOCRATIC_REPUBLIC_OF_THE_CONGO = 'cd'
             REPUBLIC_OF_THE_CONGO = 'cg'
@@ -96,7 +96,7 @@ module Flag
             SAINT_KITTS_AND_NEVIS = 'kn'
             SOUTH_KOREA = 'kr'
             KUWAIT = 'kw'
-            LAO_PEOPLE&#039;S_DEMOCRATIC_REPUBLIC = 'la'
+            LAO_PEOPLES_DEMOCRATIC_REPUBLIC = 'la'
             LEBANON = 'lb'
             LIBERIA = 'lr'
             LIBYA = 'ly'
diff --git a/lib/appwrite/enums/name.rb b/lib/appwrite/enums/name.rb
@@ -7,6 +7,7 @@ module Name
             V1_MAILS = 'v1-mails'
             V1_FUNCTIONS = 'v1-functions'
             V1_USAGE = 'v1-usage'
+            V1_USAGE_DUMP = 'v1-usage-dump'
             WEBHOOKSV1 = 'webhooksv1'
             V1_CERTIFICATES = 'v1-certificates'
             V1_BUILDS = 'v1-builds'
diff --git a/lib/appwrite/enums/password_hash.rb b/lib/appwrite/enums/password_hash.rb
@@ -5,8 +5,8 @@ module PasswordHash
             SHA224 = 'sha224'
             SHA256 = 'sha256'
             SHA384 = 'sha384'
-            SHA512/224 = 'sha512/224'
-            SHA512/256 = 'sha512/256'
+            SHA512_224 = 'sha512/224'
+            SHA512_256 = 'sha512/256'
             SHA512 = 'sha512'
             SHA3_224 = 'sha3-224'
             SHA3_256 = 'sha3-256'
diff --git a/lib/appwrite/enums/runtime.rb b/lib/appwrite/enums/runtime.rb
@@ -1,42 +1,50 @@
 module Appwrite
     module Enums
         module Runtime
-            NODE_145 = 'node-14.5'
-            NODE_160 = 'node-16.0'
-            NODE_180 = 'node-18.0'
-            NODE_190 = 'node-19.0'
-            NODE_200 = 'node-20.0'
-            PHP_80 = 'php-8.0'
-            PHP_81 = 'php-8.1'
-            PHP_82 = 'php-8.2'
-            RUBY_30 = 'ruby-3.0'
-            RUBY_31 = 'ruby-3.1'
-            RUBY_32 = 'ruby-3.2'
-            PYTHON_38 = 'python-3.8'
-            PYTHON_39 = 'python-3.9'
-            PYTHON_310 = 'python-3.10'
-            PYTHON_311 = 'python-3.11'
-            PYTHON_312 = 'python-3.12'
-            DART_215 = 'dart-2.15'
-            DART_216 = 'dart-2.16'
-            DART_217 = 'dart-2.17'
-            DART_218 = 'dart-2.18'
-            DART_30 = 'dart-3.0'
-            DART_31 = 'dart-3.1'
-            DOTNET_31 = 'dotnet-3.1'
-            DOTNET_60 = 'dotnet-6.0'
-            DOTNET_70 = 'dotnet-7.0'
-            JAVA_80 = 'java-8.0'
-            JAVA_110 = 'java-11.0'
-            JAVA_170 = 'java-17.0'
-            JAVA_180 = 'java-18.0'
-            SWIFT_55 = 'swift-5.5'
-            SWIFT_58 = 'swift-5.8'
-            KOTLIN_16 = 'kotlin-1.6'
-            KOTLIN_18 = 'kotlin-1.8'
+            NODE_14_5 = 'node-14.5'
+            NODE_16_0 = 'node-16.0'
+            NODE_18_0 = 'node-18.0'
+            NODE_19_0 = 'node-19.0'
+            NODE_20_0 = 'node-20.0'
+            NODE_21_0 = 'node-21.0'
+            PHP_8_0 = 'php-8.0'
+            PHP_8_1 = 'php-8.1'
+            PHP_8_2 = 'php-8.2'
+            PHP_8_3 = 'php-8.3'
+            RUBY_3_0 = 'ruby-3.0'
+            RUBY_3_1 = 'ruby-3.1'
+            RUBY_3_2 = 'ruby-3.2'
+            RUBY_3_3 = 'ruby-3.3'
+            PYTHON_3_8 = 'python-3.8'
+            PYTHON_3_9 = 'python-3.9'
+            PYTHON_3_10 = 'python-3.10'
+            PYTHON_3_11 = 'python-3.11'
+            PYTHON_3_12 = 'python-3.12'
+            DENO_1_40 = 'deno-1.40'
+            DART_2_15 = 'dart-2.15'
+            DART_2_16 = 'dart-2.16'
+            DART_2_17 = 'dart-2.17'
+            DART_2_18 = 'dart-2.18'
+            DART_3_0 = 'dart-3.0'
+            DART_3_1 = 'dart-3.1'
+            DART_3_3 = 'dart-3.3'
+            DOTNET_3_1 = 'dotnet-3.1'
+            DOTNET_6_0 = 'dotnet-6.0'
+            DOTNET_7_0 = 'dotnet-7.0'
+            JAVA_8_0 = 'java-8.0'
+            JAVA_11_0 = 'java-11.0'
+            JAVA_17_0 = 'java-17.0'
+            JAVA_18_0 = 'java-18.0'
+            JAVA_21_0 = 'java-21.0'
+            SWIFT_5_5 = 'swift-5.5'
+            SWIFT_5_8 = 'swift-5.8'
+            SWIFT_5_9 = 'swift-5.9'
+            KOTLIN_1_6 = 'kotlin-1.6'
+            KOTLIN_1_8 = 'kotlin-1.8'
+            KOTLIN_1_9 = 'kotlin-1.9'
             CPP_17 = 'cpp-17'
             CPP_20 = 'cpp-20'
-            BUN_10 = 'bun-1.0'
+            BUN_1_0 = 'bun-1.0'
         end
     end
 end
diff --git a/lib/appwrite/models/mfa_recovery_codes.rb b/lib/appwrite/models/mfa_recovery_codes.rb
diff --git a/lib/appwrite/models/mfa_type.rb b/lib/appwrite/models/mfa_type.rb
diff --git a/lib/appwrite/models/session.rb b/lib/appwrite/models/session.rb
diff --git a/lib/appwrite/models/user.rb b/lib/appwrite/models/user.rb
diff --git a/lib/appwrite/services/account.rb b/lib/appwrite/services/account.rb
diff --git a/lib/appwrite/services/health.rb b/lib/appwrite/services/health.rb
diff --git a/lib/appwrite/services/users.rb b/lib/appwrite/services/users.rb

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,6 @@ client = Client.new`
`10`	`10`
`11`	`11`	`account = Account.new(client)`
`12`	`12`
`13`		`-result = account.add_authenticator(`
	`13`	`+result = account.create_mfa_authenticator(`
`14`	`14`	`type: AuthenticatorType::TOTP`
`15`	`15`	`)`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@ client = Client.new`
`9`	`9`
`10`	`10`	`account = Account.new(client)`
`11`	`11`
`12`		`-result = account.create_challenge(`
`13`		`- factor: AuthenticationFactor::TOTP`
	`12`	`+result = account.create_mfa_challenge(`
	`13`	`+ factor: AuthenticationFactor::EMAIL`
`14`	`14`	`)`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ client = Client.new`
`10`	`10`
`11`	`11`	`account = Account.new(client)`
`12`	`12`
`13`		`-result = account.delete_authenticator(`
	`13`	`+result = account.delete_mfa_authenticator(`
`14`	`14`	`type: AuthenticatorType::TOTP,`
`15`	`15`	`otp: '<OTP>'`
`16`	`16`	`)`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,4 @@ client = Client.new`
`9`	`9`
`10`	`10`	`account = Account.new(client)`
`11`	`11`
`12`		`-result = account.list_factors()`
	`12`	`+result = account.list_mfa_factors()`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ client = Client.new`
`9`	`9`
`10`	`10`	`account = Account.new(client)`
`11`	`11`
`12`		`-result = account.update_challenge(`
	`12`	`+result = account.update_mfa_challenge(`
`13`	`13`	`challenge_id: '<CHALLENGE_ID>',`
`14`	`14`	`otp: '<OTP>'`
`15`	`15`	`)`