appwrite 10.1.2 → 11.0.0

data/lib/appwrite/services/avatars.rb

@@ -18,7 +18,7 @@ module Appwrite
         # image at source quality. If dimensions are not specified, the default size
         # of image returned is 100x100px.
         #
-        # @param [String] code Browser Code.
+        # @param [Browser] code Browser Code.
         # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
@@ -61,7 +61,7 @@ module Appwrite
         # of image returned is 100x100px.
         # 
         #
-        # @param [String] code Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.
+        # @param [CreditCard] code Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.
         # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
@@ -136,7 +136,7 @@ module Appwrite
         # of image returned is 100x100px.
         # 
         #
-        # @param [String] code Country Code. ISO Alpha-2 country code format.
+        # @param [Flag] code Country Code. ISO Alpha-2 country code format.
         # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100.
         # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100.

data/lib/appwrite/services/databases.rb

@@ -381,7 +381,7 @@ module Appwrite
         end
 
         
-        # 
+        # List attributes in the collection.
         #
         # @param [String] database_id Database ID.
         # @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).
@@ -472,7 +472,8 @@ module Appwrite
         end
 
         
-        # 
+        # Update a boolean attribute. Changing the `default` value will not update
+        # already existing documents.
         #
         # @param [String] database_id Database ID.
         # @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).
@@ -526,13 +527,13 @@ module Appwrite
         end
 
         
-        # 
+        # Create a date time attribute according to the ISO 8601 standard.
         #
         # @param [String] database_id Database ID.
         # @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 [String] default Default value for the attribute in ISO 8601 format. Cannot be set when attribute is required.
+        # @param [String] default Default value for the attribute in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.
         # @param [] array Is attribute an array?
         #
         # @return [AttributeDatetime]
@@ -578,7 +579,8 @@ module Appwrite
         end
 
         
-        # 
+        # Update a date time attribute. Changing the `default` value will not update
+        # already existing documents.
         #
         # @param [String] database_id Database ID.
         # @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).
@@ -741,6 +743,8 @@ module Appwrite
         end
 
         
+        # Create an enumeration attribute. The `elements` param acts as a white-list
+        # of accepted values for this attribute. 
         # 
         #
         # @param [String] database_id Database ID.
@@ -1229,11 +1233,11 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @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] related_collection_id Related Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
-        # @param [String] type Relation type
+        # @param [RelationshipType] type Relation type
         # @param [] two_way Is Two Way?
         # @param [String] key Attribute Key.
         # @param [String] two_way_key Two Way Attribute Key.
-        # @param [String] on_delete Constraints option
+        # @param [RelationMutate] on_delete Constraints option
         #
         # @return [AttributeRelationship]
         def create_relationship_attribute(database_id:, collection_id:, related_collection_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil)
@@ -1506,7 +1510,7 @@ module Appwrite
         end
 
         
-        # 
+        # Get attribute by ID.
         #
         # @param [String] database_id Database ID.
         # @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).
@@ -1547,7 +1551,7 @@ module Appwrite
         end
 
         
-        # 
+        # Deletes an attribute.
         #
         # @param [String] database_id Database ID.
         # @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).
@@ -1595,7 +1599,7 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @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 [String] on_delete Constraints option
+        # @param [RelationMutate] on_delete Constraints option
         #
         # @return [AttributeRelationship]
         def update_relationship_attribute(database_id:, collection_id:, key:, on_delete: nil)
@@ -1732,7 +1736,7 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @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] document_id Document ID.
-        # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Only method allowed is select.
+        # @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.
         #
         # @return [Document]
         def get_document(database_id:, collection_id:, document_id:, queries: nil)
@@ -1859,7 +1863,7 @@ module Appwrite
         end
 
         
-        # 
+        # List indexes in the collection.
         #
         # @param [String] database_id Database ID.
         # @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).
@@ -1897,12 +1901,14 @@ module Appwrite
         end
 
         
-        # 
+        # Creates an index on the attributes listed. Your index should include all
+        # the attributes you will query in a single request.
+        # Attributes can be `key`, `fulltext`, and `unique`.
         #
         # @param [String] database_id Database ID.
         # @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 Index Key.
-        # @param [String] type Index type.
+        # @param [IndexType] type Index type.
         # @param [Array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
         # @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
         #
@@ -1953,7 +1959,7 @@ module Appwrite
         end
 
         
-        # 
+        # Get index by ID.
         #
         # @param [String] database_id Database ID.
         # @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).
@@ -1995,7 +2001,7 @@ module Appwrite
         end
 
         
-        # 
+        # Delete an index.
         #
         # @param [String] database_id Database ID.
         # @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).

data/lib/appwrite/services/functions.rb

@@ -43,7 +43,7 @@ module Appwrite
         #
         # @param [String] function_id Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
         # @param [String] name Function name. Max length: 128 chars.
-        # @param [String] runtime Execution runtime.
+        # @param [Runtime] runtime Execution runtime.
         # @param [Array] execute An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
         # @param [Array] events Events list. Maximum of 100 events are allowed.
         # @param [String] schedule Schedule CRON syntax.
@@ -173,7 +173,7 @@ module Appwrite
         #
         # @param [String] function_id Function ID.
         # @param [String] name Function name. Max length: 128 chars.
-        # @param [String] runtime Execution runtime.
+        # @param [Runtime] runtime Execution runtime.
         # @param [Array] execute An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
         # @param [Array] events Events list. Maximum of 100 events are allowed.
         # @param [String] schedule Schedule CRON syntax.
@@ -588,7 +588,7 @@ module Appwrite
         # @param [String] body HTTP body of execution. Default value is empty string.
         # @param [] async Execute code in the background. Default value is false.
         # @param [String] xpath HTTP path of execution. Path can include query params. Default value is /
-        # @param [String] method HTTP method of execution. Default value is GET.
+        # @param [ExecutionMethod] method HTTP method of execution. Default value is GET.
         # @param [Hash] headers HTTP headers of execution. Defaults to empty.
         #
         # @return [Execution]

data/lib/appwrite/services/health.rb

@@ -80,6 +80,32 @@ module Appwrite
         end
 
         
+        # Get the SSL certificate for a domain
+        #
+        # @param [String] domain string
+        #
+        # @return [HealthCertificate]
+        def get_certificate(domain: nil)
+            api_path = '/health/certificate'
+
+            api_params = {
+                domain: domain,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthCertificate
+            )
+        end
+
+        
         # Check the Appwrite database servers are up and connection is successful.
         #
         #
@@ -264,8 +290,42 @@ module Appwrite
         end
 
         
+        # Returns the amount of failed jobs in a given queue.
         # 
         #
+        # @param [Name] name The name of the queue
+        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+        #
+        # @return [HealthQueue]
+        def get_failed_jobs(name:, threshold: nil)
+            api_path = '/health/queue/failed/{name}'
+                .gsub('{name}', name)
+
+            if name.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "name"')
+            end
+
+            api_params = {
+                threshold: threshold,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthQueue
+            )
+        end
+
+        
+        # Get the number of function executions that are waiting to be processed in
+        # the Appwrite internal queue server.
+        #
         # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
         #
         # @return [HealthQueue]
@@ -398,6 +458,60 @@ module Appwrite
         end
 
         
+        # Get the number of metrics that are waiting to be processed in the Appwrite
+        # internal queue server.
+        #
+        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+        #
+        # @return [HealthQueue]
+        def get_queue_usage(threshold: nil)
+            api_path = '/health/queue/usage'
+
+            api_params = {
+                threshold: threshold,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthQueue
+            )
+        end
+
+        
+        # Get the number of projects containing metrics that are waiting to be
+        # processed in the Appwrite internal queue server.
+        #
+        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+        #
+        # @return [HealthQueue]
+        def get_queue_usage_dump(threshold: nil)
+            api_path = '/health/queue/usage-dump'
+
+            api_params = {
+                threshold: threshold,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthQueue
+            )
+        end
+
+        
         # Get the number of webhooks that are waiting to be processed in the Appwrite
         # internal queue server.
         #
@@ -425,6 +539,30 @@ module Appwrite
         end
 
         
+        # Check the Appwrite storage device is up and connection is successful.
+        #
+        #
+        # @return [HealthStatus]
+        def get_storage()
+            api_path = '/health/storage'
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthStatus
+            )
+        end
+
+        
         # Check the Appwrite local storage device is up and connection is successful.
         #
         #