Merge pull request #56 from appwrite/dev

feat: Ruby SDK update for version 21.1.0

Author: ChiragAgg5k

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 21.1.0
+
+* Added get_console_pausing health endpoint to monitor console pausing.
+* Added ttl parameter for cached responses in list_documents and list_rows.
+* Made activate parameter optional in Sites.create_deployment.
+* Updated collection_id doc to reference collection instead of table.
+* Added update_relationship_attribute API to update relationship attributes.
+* Updated team roles length limit docstrings from 32 to 81 chars.
+* Updated subscriber list docs to reflect new query filters.
+* Added Ruby example for health get_console_pausing.
+
 ## 21.0.1
 
 * Remove obsolete GitHub issue templates (bug.yaml, documentation.yaml, feature.yaml) to simplify repository maintenance.

appwrite.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name = 'appwrite'
-  spec.version = '21.0.1'
+  spec.version = '21.1.0'
   spec.license = 'BSD-3-Clause'
   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'

docs/examples/databases/list-documents.md

@@ -15,6 +15,7 @@ result = databases.list_documents(
     collection_id: '<COLLECTION_ID>',
     queries: [], # optional
     transaction_id: '<TRANSACTION_ID>', # optional
-    total: false # optional
+    total: false, # optional
+    ttl: 0 # optional
 )
 ```

docs/examples/health/get-console-pausing.md

@@ -0,0 +1,17 @@
+```ruby
+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
+
+health = Health.new(client)
+
+result = health.get_console_pausing(
+    threshold: null, # optional
+    inactivity_days: null # optional
+)
+```

docs/examples/sites/create-deployment.md

@@ -13,9 +13,9 @@ sites = Sites.new(client)
 result = sites.create_deployment(
     site_id: '<SITE_ID>',
     code: InputFile.from_path('dir/file.png'),
-    activate: false,
     install_command: '<INSTALL_COMMAND>', # optional
     build_command: '<BUILD_COMMAND>', # optional
-    output_directory: '<OUTPUT_DIRECTORY>' # optional
+    output_directory: '<OUTPUT_DIRECTORY>', # optional
+    activate: false # optional
 )
 ```

docs/examples/tablesdb/list-rows.md

@@ -15,6 +15,7 @@ result = tables_db.list_rows(
     table_id: '<TABLE_ID>',
     queries: [], # optional
     transaction_id: '<TRANSACTION_ID>', # optional
-    total: false # optional
+    total: false, # optional
+    ttl: 0 # optional
 )
 ```

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'=> '21.0.1',
+                'x-sdk-version'=> '21.1.0',
                 'X-Appwrite-Response-Format' => '1.8.0'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'

lib/appwrite/services/databases.rb

@@ -614,7 +614,7 @@ def list_attributes(database_id:, collection_id:, queries: nil, total: nil)
         # 
         #
         # @param [String] database_id Database ID.
-        # @param [String] collection_id Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+        # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
         # @param [String] key Attribute Key.
         # @param [] required Is attribute required?
         # @param [] default Default value for attribute when not provided. Cannot be set when attribute is required.
@@ -2043,6 +2043,56 @@ def create_relationship_attribute(database_id:, collection_id:, related_collecti
             )
         end
 
+        #
+        # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRelationshipColumn` instead.
+        #
+        # Update relationship attribute. [Learn more about relationship
+        # attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
+        # 
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] collection_id Collection ID.
+        # @param [String] key Attribute Key.
+        # @param [RelationMutate] on_delete Constraints option
+        # @param [String] new_key New Attribute Key.
+        #
+        # @return [AttributeRelationship]
+        def update_relationship_attribute(database_id:, collection_id:, key:, on_delete: nil, new_key: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship/{key}'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+                .gsub('{key}', key)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if collection_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
+            end
+
+            if key.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "key"')
+            end
+
+            api_params = {
+                onDelete: on_delete,
+                newKey: new_key,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AttributeRelationship
+            )
+        end
+
         #
         # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createStringColumn` instead.
         #
@@ -2599,56 +2649,6 @@ def delete_attribute(database_id:, collection_id:, key:)
             )
         end
 
-        #
-        # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRelationshipColumn` instead.
-        #
-        # Update relationship attribute. [Learn more about relationship
-        # attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
-        # 
-        #
-        # @param [String] database_id Database ID.
-        # @param [String] collection_id Collection ID.
-        # @param [String] key Attribute Key.
-        # @param [RelationMutate] on_delete Constraints option
-        # @param [String] new_key New Attribute Key.
-        #
-        # @return [AttributeRelationship]
-        def update_relationship_attribute(database_id:, collection_id:, key:, on_delete: nil, new_key: nil)
-            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'
-                .gsub('{databaseId}', database_id)
-                .gsub('{collectionId}', collection_id)
-                .gsub('{key}', key)
-
-            if database_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
-            end
-
-            if collection_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
-            end
-
-            if key.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "key"')
-            end
-
-            api_params = {
-                onDelete: on_delete,
-                newKey: new_key,
-            }
-            
-            api_headers = {
-                "content-type": 'application/json',
-            }
-
-            @client.call(
-                method: 'PATCH',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::AttributeRelationship
-            )
-        end
-
         #
         # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
         #
@@ -2660,9 +2660,10 @@ def update_relationship_attribute(database_id:, collection_id:, key:, on_delete:
         # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
         # @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
+        # @param [Integer] ttl TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
         #
         # @return [DocumentList]
-        def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil)
+        def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil, ttl: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2679,6 +2680,7 @@ def list_documents(database_id:, collection_id:, queries: nil, transaction_id: n
                 queries: queries,
                 transactionId: transaction_id,
                 total: total,
+                ttl: ttl,
             }
 
             api_headers = {

lib/appwrite/services/health.rb

@@ -98,6 +98,34 @@ def get_certificate(domain: nil)
             )
         end
 
+        # Get console pausing health status. Monitors projects approaching the pause
+        # threshold to detect potential issues with console access tracking.
+        # 
+        #
+        # @param [Integer] threshold Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.
+        # @param [Integer] inactivity_days Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.
+        #
+        # @return [HealthStatus]
+        def get_console_pausing(threshold: nil, inactivity_days: nil)
+            api_path = '/health/console-pausing'
+
+            api_params = {
+                threshold: threshold,
+                inactivityDays: inactivity_days,
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthStatus
+            )
+        end
+
         # Check the Appwrite database servers are up and connection is successful.
         #
         #

lib/appwrite/services/messaging.rb

@@ -1802,7 +1802,7 @@ def list_topic_logs(topic_id:, queries: nil, total: nil)
         # Get a list of all subscribers from the current Appwrite project.
         #
         # @param [String] topic_id Topic ID. The topic ID subscribed to.
-        # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
+        # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: targetId, topicId, userId, providerType
         # @param [String] search Search term to filter your list results. Max length: 256 chars.
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #