Merge pull request #49 from appwrite/dev

feat: Ruby SDK update for version 20.0.0

Author: abnegate

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 20.0.0
+
+* Rename `VCSDeploymentType` enum to `VCSReferenceType`
+* 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
+
 ## 19.3.0
 
 * Add `total` parameter to list queries allowing skipping counting rows in a table for improved performance

appwrite.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name = 'appwrite'
-  spec.version = '19.3.0'
+  spec.version = '20.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'

docs/examples/avatars/get-screenshot.md

@@ -0,0 +1,37 @@
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+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
+
+avatars = Avatars.new(client)
+
+result = avatars.get_screenshot(
+    url: 'https://example.com',
+    headers: {
+        "Authorization" => "Bearer token123",
+        "X-Custom-Header" => "value"
+    }, # optional
+    viewport_width: 1920, # optional
+    viewport_height: 1080, # optional
+    scale: 2, # optional
+    theme: Theme::LIGHT, # optional
+    user_agent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15', # optional
+    fullpage: true, # optional
+    locale: 'en-US', # optional
+    timezone: Timezone::AFRICA_ABIDJAN, # optional
+    latitude: 37.7749, # optional
+    longitude: -122.4194, # optional
+    accuracy: 100, # optional
+    touch: true, # optional
+    permissions: ["geolocation","notifications"], # optional
+    sleep: 3, # optional
+    width: 800, # optional
+    height: 600, # optional
+    quality: 85, # optional
+    output: Output::JPG # optional
+)

docs/examples/databases/update-relationship-attribute.md

@@ -1,6 +1,7 @@
 require 'appwrite'
 
 include Appwrite
+include Appwrite::Enums
 
 client = Client.new
     .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint

docs/examples/functions/create-execution.md

@@ -1,6 +1,7 @@
 require 'appwrite'
 
 include Appwrite
+include Appwrite::Enums
 
 client = Client.new
     .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint

docs/examples/functions/create-template-deployment.md

@@ -1,6 +1,7 @@
 require 'appwrite'
 
 include Appwrite
+include Appwrite::Enums
 
 client = Client.new
     .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -14,6 +15,7 @@ result = functions.create_template_deployment(
     repository: '<REPOSITORY>',
     owner: '<OWNER>',
     root_directory: '<ROOT_DIRECTORY>',
-    version: '<VERSION>',
+    type: TemplateReferenceType::COMMIT,
+    reference: '<REFERENCE>',
     activate: false # optional
 )

docs/examples/functions/create-vcs-deployment.md

@@ -12,7 +12,7 @@ functions = Functions.new(client)
 
 result = functions.create_vcs_deployment(
     function_id: '<FUNCTION_ID>',
-    type: VCSDeploymentType::BRANCH,
+    type: VCSReferenceType::BRANCH,
     reference: '<REFERENCE>',
     activate: false # optional
 )

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: Runtime::NODE_14_5,
     execute: ["any"], # optional
     events: [], # optional
     schedule: '', # optional

docs/examples/functions/get-deployment-download.md

@@ -1,6 +1,7 @@
 require 'appwrite'
 
 include Appwrite
+include Appwrite::Enums
 
 client = Client.new
     .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint

docs/examples/functions/update.md

@@ -1,6 +1,7 @@
 require 'appwrite'
 
 include Appwrite
+include Appwrite::Enums
 
 client = Client.new
     .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -12,7 +13,7 @@ functions = Functions.new(client)
 result = functions.update(
     function_id: '<FUNCTION_ID>',
     name: '<NAME>',
-    runtime: ::NODE_14_5, # optional
+    runtime: Runtime::NODE_14_5, # optional
     execute: ["any"], # optional
     events: [], # optional
     schedule: '', # optional