appwrite 20.0.0 → 21.0.0

data/lib/appwrite/services/databases.rb

@@ -291,7 +291,7 @@ module Appwrite
         # @param [] enabled Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
         #
         # @return [Database]
-        def update(database_id:, name:, enabled: nil)
+        def update(database_id:, name: nil, enabled: nil)
             api_path = '/databases/{databaseId}'
                 .gsub('{databaseId}', database_id)
 
@@ -299,10 +299,6 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
             end
 
-            if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
-            end
-
             api_params = {
                 name: name,
                 enabled: enabled,
@@ -405,9 +401,11 @@ module Appwrite
         # @param [Array] permissions An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
         # @param [] document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
         # @param [] enabled Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+        # @param [Array] attributes Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, integer, float, boolean, datetime), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
+        # @param [Array] indexes Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
         #
         # @return [Collection]
-        def create_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil)
+        def create_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil, attributes: nil, indexes: nil)
             api_path = '/databases/{databaseId}/collections'
                 .gsub('{databaseId}', database_id)
 
@@ -429,6 +427,8 @@ module Appwrite
                 permissions: permissions,
                 documentSecurity: document_security,
                 enabled: enabled,
+                attributes: attributes,
+                indexes: indexes,
             }
             
             api_headers = {
@@ -495,7 +495,7 @@ module Appwrite
         # @param [] enabled Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
         #
         # @return [Collection]
-        def update_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil)
+        def update_collection(database_id:, collection_id:, name: nil, permissions: nil, document_security: nil, enabled: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -508,10 +508,6 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
             end
 
-            if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
-            end
-
             api_params = {
                 name: name,
                 permissions: permissions,
@@ -1551,6 +1547,224 @@ module Appwrite
             )
         end
 
+        # Create a longtext 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).
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [] array Is attribute an array?
+        #
+        # @return [AttributeLongtext]
+        def create_longtext_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/longtext'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+
+            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
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            api_params = {
+                key: key,
+                required: required,
+                default: default,
+                array: array,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AttributeLongtext
+            )
+        end
+
+        # Update a longtext 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).
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [String] new_key New Attribute Key.
+        #
+        # @return [AttributeLongtext]
+        def update_longtext_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/longtext/{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
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            if default.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "default"')
+            end
+
+            api_params = {
+                required: required,
+                default: default,
+                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::AttributeLongtext
+            )
+        end
+
+        # Create a mediumtext 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).
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [] array Is attribute an array?
+        #
+        # @return [AttributeMediumtext]
+        def create_mediumtext_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+
+            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
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            api_params = {
+                key: key,
+                required: required,
+                default: default,
+                array: array,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AttributeMediumtext
+            )
+        end
+
+        # Update a mediumtext 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).
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [String] new_key New Attribute Key.
+        #
+        # @return [AttributeMediumtext]
+        def update_mediumtext_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext/{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
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            if default.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "default"')
+            end
+
+            api_params = {
+                required: required,
+                default: default,
+                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::AttributeMediumtext
+            )
+        end
+
         #
         # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createPointColumn` instead.
         #
@@ -1950,6 +2164,115 @@ module Appwrite
             )
         end
 
+        # Create a text 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).
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [] array Is attribute an array?
+        #
+        # @return [AttributeText]
+        def create_text_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/text'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+
+            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
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            api_params = {
+                key: key,
+                required: required,
+                default: default,
+                array: array,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AttributeText
+            )
+        end
+
+        # Update a text 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).
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [String] new_key New Attribute Key.
+        #
+        # @return [AttributeText]
+        def update_text_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/text/{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
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            if default.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "default"')
+            end
+
+            api_params = {
+                required: required,
+                default: default,
+                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::AttributeText
+            )
+        end
+
         #
         # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createUrlColumn` instead.
         #
@@ -2065,6 +2388,123 @@ module Appwrite
             )
         end
 
+        # Create a varchar 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).
+        # @param [String] key Attribute Key.
+        # @param [Integer] size Attribute size for varchar attributes, in number of characters. Maximum size is 16381.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [] array Is attribute an array?
+        #
+        # @return [AttributeVarchar]
+        def create_varchar_attribute(database_id:, collection_id:, key:, size:, required:, default: nil, array: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/varchar'
+                .gsub('{databaseId}', database_id)
+                .gsub('{collectionId}', collection_id)
+
+            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
+
+            if size.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "size"')
+            end
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            api_params = {
+                key: key,
+                size: size,
+                required: required,
+                default: default,
+                array: array,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AttributeVarchar
+            )
+        end
+
+        # Update a varchar 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).
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
+        # @param [Integer] size Maximum size of the varchar attribute.
+        # @param [String] new_key New Attribute Key.
+        #
+        # @return [AttributeVarchar]
+        def update_varchar_attribute(database_id:, collection_id:, key:, required:, default:, size: nil, new_key: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/varchar/{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
+
+            if required.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "required"')
+            end
+
+            if default.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "default"')
+            end
+
+            api_params = {
+                required: required,
+                default: default,
+                size: size,
+                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::AttributeVarchar
+            )
+        end
+
         #
         # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.getColumn` instead.
         #
@@ -2104,6 +2544,7 @@ module Appwrite
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
+                response_type: Models::AttributeBoolean
             )
         end
 
@@ -2553,7 +2994,7 @@ module Appwrite
         # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [Document]
-        def upsert_document(database_id:, collection_id:, document_id:, data:, permissions: nil, transaction_id: nil)
+        def upsert_document(database_id:, collection_id:, document_id:, data: nil, permissions: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2571,10 +3012,6 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "documentId"')
             end
 
-            if data.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "data"')
-            end
-
             api_params = {
                 data: data,
                 permissions: permissions,

data/lib/appwrite/services/health.rb

@@ -55,7 +55,7 @@ module Appwrite
         # successful.
         #
         #
-        # @return [HealthStatus]
+        # @return [HealthStatusList]
         def get_cache()
             api_path = '/health/cache'
 
@@ -70,7 +70,7 @@ module Appwrite
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::HealthStatus
+                response_type: Models::HealthStatusList
             )
         end
 
@@ -101,7 +101,7 @@ module Appwrite
         # Check the Appwrite database servers are up and connection is successful.
         #
         #
-        # @return [HealthStatus]
+        # @return [HealthStatusList]
         def get_db()
             api_path = '/health/db'
 
@@ -116,14 +116,14 @@ module Appwrite
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::HealthStatus
+                response_type: Models::HealthStatusList
             )
         end
 
         # Check the Appwrite pub-sub servers are up and connection is successful.
         #
         #
-        # @return [HealthStatus]
+        # @return [HealthStatusList]
         def get_pub_sub()
             api_path = '/health/pubsub'
 
@@ -138,7 +138,32 @@ module Appwrite
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::HealthStatus
+                response_type: Models::HealthStatusList
+            )
+        end
+
+        # Get the number of audit logs 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_audits(threshold: nil)
+            api_path = '/health/queue/audits'
+
+            api_params = {
+                threshold: threshold,
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::HealthQueue
             )
         end
 

data/lib/appwrite/services/storage.rb

@@ -45,7 +45,7 @@ module Appwrite
         # @param [] enabled Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
         # @param [Integer] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB.
         # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
-        # @param [Compression] compression Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
+        # @param [Compression] compression Compression algorithm chosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
         # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
         # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         # @param [] transformations Are image transformations enabled?
@@ -127,7 +127,7 @@ module Appwrite
         # @param [] enabled Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
         # @param [Integer] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB.
         # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
-        # @param [Compression] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
+        # @param [Compression] compression Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
         # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
         # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         # @param [] transformations Are image transformations enabled?
@@ -337,10 +337,10 @@ module Appwrite
         # Update a file by its unique ID. Only users with write permissions have
         # access to update this resource.
         #
-        # @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
-        # @param [String] file_id File unique ID.
-        # @param [String] name Name of the file
-        # @param [Array] permissions An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+        # @param [String] bucket_id Bucket unique ID.
+        # @param [String] file_id File ID.
+        # @param [String] name File name.
+        # @param [Array] permissions An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
         #
         # @return [File]
         def update_file(bucket_id:, file_id:, name: nil, permissions: nil)