appwrite 22.0.0 → 23.1.0

data/lib/appwrite/services/databases.rb

@@ -37,6 +37,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::DatabaseList
             )
+
         end
 
         #
@@ -78,6 +79,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Database
             )
+
         end
 
         # List transactions across all databases.
@@ -102,6 +104,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::TransactionList
             )
+
         end
 
         # Create a new transaction.
@@ -127,6 +130,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Transaction
             )
+
         end
 
         # Get a transaction by its unique ID.
@@ -155,6 +159,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Transaction
             )
+
         end
 
         # Update a transaction, to either commit or roll back its operations.
@@ -188,6 +193,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Transaction
             )
+
         end
 
         # Delete a transaction by its unique ID.
@@ -216,6 +222,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Create multiple operations in a single transaction.
@@ -247,6 +254,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Transaction
             )
+
         end
 
         #
@@ -279,6 +287,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Database
             )
+
         end
 
         #
@@ -315,6 +324,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Database
             )
+
         end
 
         #
@@ -347,6 +357,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         #
@@ -385,6 +396,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::CollectionList
             )
+
         end
 
         #
@@ -442,6 +454,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Collection
             )
+
         end
 
         #
@@ -480,6 +493,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Collection
             )
+
         end
 
         #
@@ -493,9 +507,10 @@ module Appwrite
         # @param [Array] permissions An array of permission strings. By default, the current permissions are inherited. [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 [] purge When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
         #
         # @return [Collection]
-        def update_collection(database_id:, collection_id:, name: nil, permissions: nil, document_security: nil, enabled: nil)
+        def update_collection(database_id:, collection_id:, name: nil, permissions: nil, document_security: nil, enabled: nil, purge: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -513,6 +528,7 @@ module Appwrite
                 permissions: permissions,
                 documentSecurity: document_security,
                 enabled: enabled,
+                purge: purge,
             }
             
             api_headers = {
@@ -526,6 +542,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Collection
             )
+
         end
 
         #
@@ -564,6 +581,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         #
@@ -605,6 +623,133 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeList
             )
+
+        end
+
+        #
+        # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createBigIntColumn` instead.
+        #
+        # Create a bigint attribute. Optionally, minimum and maximum values can be
+        # provided.
+        # 
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] collection_id Collection ID.
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [Integer] min Minimum value
+        # @param [Integer] max Maximum value
+        # @param [Integer] default Default value. Cannot be set when attribute is required.
+        # @param [] array Is attribute an array?
+        #
+        # @return [AttributeBigint]
+        def create_big_int_attribute(database_id:, collection_id:, key:, required:, min: nil, max: nil, default: nil, array: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/bigint'
+                .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,
+                min: min,
+                max: max,
+                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::AttributeBigint
+            )
+
+        end
+
+        #
+        # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateBigIntColumn` instead.
+        #
+        # Update a bigint attribute. Changing the `default` value will not update
+        # already existing documents.
+        # 
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] collection_id Collection ID.
+        # @param [String] key Attribute Key.
+        # @param [] required Is attribute required?
+        # @param [Integer] default Default value. Cannot be set when attribute is required.
+        # @param [Integer] min Minimum value
+        # @param [Integer] max Maximum value
+        # @param [String] new_key New Attribute Key.
+        #
+        # @return [AttributeBigint]
+        def update_big_int_attribute(database_id:, collection_id:, key:, required:, default:, min: nil, max: nil, new_key: nil)
+            api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/bigint/{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,
+                min: min,
+                max: max,
+                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::AttributeBigint
+            )
+
         end
 
         #
@@ -660,6 +805,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeBoolean
             )
+
         end
 
         #
@@ -719,6 +865,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeBoolean
             )
+
         end
 
         #
@@ -773,6 +920,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeDatetime
             )
+
         end
 
         #
@@ -832,6 +980,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeDatetime
             )
+
         end
 
         #
@@ -887,6 +1036,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeEmail
             )
+
         end
 
         #
@@ -947,6 +1097,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeEmail
             )
+
         end
 
         #
@@ -1009,6 +1160,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeEnum
             )
+
         end
 
         #
@@ -1075,6 +1227,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeEnum
             )
+
         end
 
         #
@@ -1135,6 +1288,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeFloat
             )
+
         end
 
         #
@@ -1199,6 +1353,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeFloat
             )
+
         end
 
         #
@@ -1259,6 +1414,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeInteger
             )
+
         end
 
         #
@@ -1323,6 +1479,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeInteger
             )
+
         end
 
         #
@@ -1378,6 +1535,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeIp
             )
+
         end
 
         #
@@ -1438,6 +1596,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeIp
             )
+
         end
 
         #
@@ -1490,6 +1649,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeLine
             )
+
         end
 
         #
@@ -1545,6 +1705,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeLine
             )
+
         end
 
         # Create a longtext attribute.
@@ -1599,6 +1760,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeLongtext
             )
+
         end
 
         # Update a longtext attribute. Changing the `default` value will not update
@@ -1656,6 +1818,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeLongtext
             )
+
         end
 
         # Create a mediumtext attribute.
@@ -1710,6 +1873,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeMediumtext
             )
+
         end
 
         # Update a mediumtext attribute. Changing the `default` value will not update
@@ -1767,6 +1931,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeMediumtext
             )
+
         end
 
         #
@@ -1819,6 +1984,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributePoint
             )
+
         end
 
         #
@@ -1874,6 +2040,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributePoint
             )
+
         end
 
         #
@@ -1926,6 +2093,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributePolygon
             )
+
         end
 
         #
@@ -1981,6 +2149,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributePolygon
             )
+
         end
 
         #
@@ -2041,6 +2210,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeRelationship
             )
+
         end
 
         #
@@ -2091,6 +2261,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeRelationship
             )
+
         end
 
         #
@@ -2154,6 +2325,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeString
             )
+
         end
 
         #
@@ -2216,6 +2388,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeString
             )
+
         end
 
         # Create a text attribute.
@@ -2270,6 +2443,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeText
             )
+
         end
 
         # Update a text attribute. Changing the `default` value will not update
@@ -2327,6 +2501,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeText
             )
+
         end
 
         #
@@ -2382,6 +2557,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeUrl
             )
+
         end
 
         #
@@ -2442,6 +2618,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeUrl
             )
+
         end
 
         # Create a varchar attribute.
@@ -2502,6 +2679,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeVarchar
             )
+
         end
 
         # Update a varchar attribute. Changing the `default` value will not update
@@ -2561,6 +2739,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AttributeVarchar
             )
+
         end
 
         #
@@ -2572,7 +2751,7 @@ module Appwrite
         # @param [String] collection_id Collection ID.
         # @param [String] key Attribute Key.
         #
-        # @return []
+        # @return [AttributeBoolean, AttributeInteger, AttributeFloat, AttributeEmail, AttributeEnum, AttributeUrl, AttributeIp, AttributeDatetime, AttributeRelationship, AttributeString]
         def get_attribute(database_id:, collection_id:, key:)
             api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'
                 .gsub('{databaseId}', database_id)
@@ -2597,13 +2776,69 @@ module Appwrite
             api_headers = {
             }
 
-            @client.call(
+            response = @client.call(
                 method: 'GET',
                 path: api_path,
                 headers: api_headers,
                 params: api_params,
-                response_type: Models::AttributeBoolean
             )
+
+            unless response.is_a?(Hash)
+                raise Exception, "Expected object response when hydrating a response model"
+            end
+
+            if response['type'] == 'string' && response['format'] == 'email'
+
+                return Models::AttributeEmail.from(map: response)
+            end
+
+            if response['type'] == 'string' && response['format'] == 'enum'
+
+                return Models::AttributeEnum.from(map: response)
+            end
+
+            if response['type'] == 'string' && response['format'] == 'url'
+
+                return Models::AttributeUrl.from(map: response)
+            end
+
+            if response['type'] == 'string' && response['format'] == 'ip'
+
+                return Models::AttributeIp.from(map: response)
+            end
+
+            if response['type'] == 'boolean'
+
+                return Models::AttributeBoolean.from(map: response)
+            end
+
+            if response['type'] == 'integer'
+
+                return Models::AttributeInteger.from(map: response)
+            end
+
+            if response['type'] == 'double'
+
+                return Models::AttributeFloat.from(map: response)
+            end
+
+            if response['type'] == 'datetime'
+
+                return Models::AttributeDatetime.from(map: response)
+            end
+
+            if response['type'] == 'relationship'
+
+                return Models::AttributeRelationship.from(map: response)
+            end
+
+            if response['type'] == 'string'
+
+                return Models::AttributeString.from(map: response)
+            end
+
+            raise Exception, "Unable to match response to any expected response model"
+
         end
 
         #
@@ -2647,6 +2882,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         #
@@ -2660,7 +2896,7 @@ module Appwrite
         # @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).
+        # @param [Integer] ttl TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
         #
         # @return [DocumentList]
         def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil, ttl: nil)
@@ -2693,6 +2929,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::DocumentList
             )
+
         end
 
         #
@@ -2750,6 +2987,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Document
             )
+
         end
 
         #
@@ -2799,6 +3037,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::DocumentList
             )
+
         end
 
         #
@@ -2849,6 +3088,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::DocumentList
             )
+
         end
 
         #
@@ -2895,6 +3135,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::DocumentList
             )
+
         end
 
         #
@@ -2938,6 +3179,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::DocumentList
             )
+
         end
 
         #
@@ -2986,6 +3228,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Document
             )
+
         end
 
         #
@@ -3039,6 +3282,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Document
             )
+
         end
 
         #
@@ -3090,6 +3334,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Document
             )
+
         end
 
         #
@@ -3135,6 +3380,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         #
@@ -3191,6 +3437,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Document
             )
+
         end
 
         #
@@ -3247,6 +3494,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Document
             )
+
         end
 
         #
@@ -3288,6 +3536,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::IndexList
             )
+
         end
 
         #
@@ -3350,6 +3599,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Index
             )
+
         end
 
         #
@@ -3393,6 +3643,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Index
             )
+
         end
 
         #
@@ -3436,7 +3687,8 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
     end 
-end
+end