appwrite 19.1.0 → 19.3.0

data/lib/appwrite/services/databases.rb

@@ -15,14 +15,16 @@ 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. You may filter on the following attributes: name
         # @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.
         #
         # @return [DatabaseList]
-        def list(queries: nil, search: nil)
+        def list(queries: nil, search: nil, total: nil)
             api_path = '/databases'
 
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -78,6 +80,175 @@ module Appwrite
             )
         end
 
+        # List transactions across all databases.
+        #
+        # @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).
+        #
+        # @return [TransactionList]
+        def list_transactions(queries: nil)
+            api_path = '/databases/transactions'
+
+            api_params = {
+                queries: queries,
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::TransactionList
+            )
+        end
+
+        # Create a new transaction.
+        #
+        # @param [Integer] ttl Seconds before the transaction expires.
+        #
+        # @return [Transaction]
+        def create_transaction(ttl: nil)
+            api_path = '/databases/transactions'
+
+            api_params = {
+                ttl: ttl,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Transaction
+            )
+        end
+
+        # Get a transaction by its unique ID.
+        #
+        # @param [String] transaction_id Transaction ID.
+        #
+        # @return [Transaction]
+        def get_transaction(transaction_id:)
+            api_path = '/databases/transactions/{transactionId}'
+                .gsub('{transactionId}', transaction_id)
+
+            if transaction_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Transaction
+            )
+        end
+
+        # Update a transaction, to either commit or roll back its operations.
+        #
+        # @param [String] transaction_id Transaction ID.
+        # @param [] commit Commit transaction?
+        # @param [] rollback Rollback transaction?
+        #
+        # @return [Transaction]
+        def update_transaction(transaction_id:, commit: nil, rollback: nil)
+            api_path = '/databases/transactions/{transactionId}'
+                .gsub('{transactionId}', transaction_id)
+
+            if transaction_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
+            end
+
+            api_params = {
+                commit: commit,
+                rollback: rollback,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Transaction
+            )
+        end
+
+        # Delete a transaction by its unique ID.
+        #
+        # @param [String] transaction_id Transaction ID.
+        #
+        # @return []
+        def delete_transaction(transaction_id:)
+            api_path = '/databases/transactions/{transactionId}'
+                .gsub('{transactionId}', transaction_id)
+
+            if transaction_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+        end
+
+        # Create multiple operations in a single transaction.
+        #
+        # @param [String] transaction_id Transaction ID.
+        # @param [Array] operations Array of staged operations.
+        #
+        # @return [Transaction]
+        def create_operations(transaction_id:, operations: nil)
+            api_path = '/databases/transactions/{transactionId}/operations'
+                .gsub('{transactionId}', transaction_id)
+
+            if transaction_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
+            end
+
+            api_params = {
+                operations: operations,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Transaction
+            )
+        end
+
         #
         # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.get` instead.
         #
@@ -191,9 +362,10 @@ module Appwrite
         # @param [String] database_id Database 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity
         # @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.
         #
         # @return [CollectionList]
-        def list_collections(database_id:, queries: nil, search: nil)
+        def list_collections(database_id:, queries: nil, search: nil, total: nil)
             api_path = '/databases/{databaseId}/collections'
                 .gsub('{databaseId}', database_id)
 
@@ -204,6 +376,7 @@ module Appwrite
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -405,9 +578,10 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, size, required, array, status, error
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [AttributeList]
-        def list_attributes(database_id:, collection_id:, queries: nil)
+        def list_attributes(database_id:, collection_id:, queries: nil, total: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/attributes'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -422,6 +596,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {
@@ -2034,9 +2209,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 [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.
         #
         # @return [DocumentList]
-        def list_documents(database_id:, collection_id:, queries: nil)
+        def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2051,6 +2228,8 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                transactionId: transaction_id,
+                total: total,
             }
             
             api_headers = {
@@ -2078,9 +2257,10 @@ module Appwrite
         # @param [String] document_id Document 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 [Hash] data Document data as JSON object.
         # @param [Array] permissions An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+        # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [Document]
-        def create_document(database_id:, collection_id:, document_id:, data:, permissions: nil)
+        def create_document(database_id:, collection_id:, document_id:, data:, permissions: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2105,6 +2285,7 @@ module Appwrite
                 documentId: document_id,
                 data: data,
                 permissions: permissions,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2131,9 +2312,10 @@ 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). Make sure to define attributes before creating documents.
         # @param [Array] documents Array of documents data as JSON objects.
+        # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [DocumentList]
-        def create_documents(database_id:, collection_id:, documents:)
+        def create_documents(database_id:, collection_id:, documents:, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2152,6 +2334,7 @@ module Appwrite
 
             api_params = {
                 documents: documents,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2179,9 +2362,10 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID.
         # @param [Array] documents Array of document data as JSON objects. May contain partial documents.
+        # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [DocumentList]
-        def upsert_documents(database_id:, collection_id:, documents:)
+        def upsert_documents(database_id:, collection_id:, documents:, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2200,6 +2384,7 @@ module Appwrite
 
             api_params = {
                 documents: documents,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2226,9 +2411,10 @@ module Appwrite
         # @param [String] collection_id Collection ID.
         # @param [Hash] data Document data as JSON object. Include only attribute and value pairs to be updated.
         # @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 for staging the operation.
         #
         # @return [DocumentList]
-        def update_documents(database_id:, collection_id:, data: nil, queries: nil)
+        def update_documents(database_id:, collection_id:, data: nil, queries: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2244,6 +2430,7 @@ module Appwrite
             api_params = {
                 data: data,
                 queries: queries,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2268,9 +2455,10 @@ 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 [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 for staging the operation.
         #
         # @return [DocumentList]
-        def delete_documents(database_id:, collection_id:, queries: nil)
+        def delete_documents(database_id:, collection_id:, queries: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2285,6 +2473,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2310,9 +2499,10 @@ module Appwrite
         # @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/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+        # @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
         #
         # @return [Document]
-        def get_document(database_id:, collection_id:, document_id:, queries: nil)
+        def get_document(database_id:, collection_id:, document_id:, queries: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2332,6 +2522,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2359,9 +2550,10 @@ module Appwrite
         # @param [String] document_id Document ID.
         # @param [Hash] data Document data as JSON object. Include all required attributes of the document to be created or updated.
         # @param [Array] permissions An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+        # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [Document]
-        def upsert_document(database_id:, collection_id:, document_id:, data:, permissions: nil)
+        def upsert_document(database_id:, collection_id:, document_id:, data:, permissions: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2386,6 +2578,7 @@ module Appwrite
             api_params = {
                 data: data,
                 permissions: permissions,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2412,9 +2605,10 @@ module Appwrite
         # @param [String] document_id Document ID.
         # @param [Hash] data Document data as JSON object. Include only attribute and value pairs to be updated.
         # @param [Array] permissions An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+        # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [Document]
-        def update_document(database_id:, collection_id:, document_id:, data: nil, permissions: nil)
+        def update_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)
@@ -2435,6 +2629,7 @@ module Appwrite
             api_params = {
                 data: data,
                 permissions: permissions,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2458,9 +2653,10 @@ 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 [String] transaction_id Transaction ID for staging the operation.
         #
         # @return []
-        def delete_document(database_id:, collection_id:, document_id:)
+        def delete_document(database_id:, collection_id:, document_id:, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2479,6 +2675,7 @@ module Appwrite
             end
 
             api_params = {
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2504,9 +2701,10 @@ module Appwrite
         # @param [String] attribute Attribute key.
         # @param [Float] value Value to increment the attribute by. The value must be a number.
         # @param [Float] min Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.
+        # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [Document]
-        def decrement_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, min: nil)
+        def decrement_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, min: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2532,6 +2730,7 @@ module Appwrite
             api_params = {
                 value: value,
                 min: min,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2558,9 +2757,10 @@ module Appwrite
         # @param [String] attribute Attribute key.
         # @param [Float] value Value to increment the attribute by. The value must be a number.
         # @param [Float] max Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.
+        # @param [String] transaction_id Transaction ID for staging the operation.
         #
         # @return [Document]
-        def increment_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, max: nil)
+        def increment_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, max: nil, transaction_id: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2586,6 +2786,7 @@ module Appwrite
             api_params = {
                 value: value,
                 max: max,
+                transactionId: transaction_id,
             }
             
             api_headers = {
@@ -2609,9 +2810,10 @@ 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 [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: key, type, status, attributes, error
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [IndexList]
-        def list_indexes(database_id:, collection_id:, queries: nil)
+        def list_indexes(database_id:, collection_id:, queries: nil, total: nil)
             api_path = '/databases/{databaseId}/collections/{collectionId}/indexes'
                 .gsub('{databaseId}', database_id)
                 .gsub('{collectionId}', collection_id)
@@ -2626,6 +2828,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {
@@ -2705,7 +2908,7 @@ module Appwrite
         #
         # @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.getIndex` instead.
         #
-        # Get index by ID.
+        # Get an index by its unique 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).

data/lib/appwrite/services/functions.rb

@@ -12,14 +12,16 @@ 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. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
         # @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.
         #
         # @return [FunctionList]
-        def list(queries: nil, search: nil)
+        def list(queries: nil, search: nil, total: nil)
             api_path = '/functions'
 
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -317,9 +319,10 @@ module Appwrite
         # @param [String] function_id Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
         # @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.
         #
         # @return [DeploymentList]
-        def list_deployments(function_id:, queries: nil, search: nil)
+        def list_deployments(function_id:, queries: nil, search: nil, total: nil)
             api_path = '/functions/{functionId}/deployments'
                 .gsub('{functionId}', function_id)
 
@@ -330,6 +333,7 @@ module Appwrite
             api_params = {
                 queries: queries,
                 search: search,
+                total: total,
             }
             
             api_headers = {
@@ -697,9 +701,10 @@ module Appwrite
         #
         # @param [String] function_id Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [ExecutionList]
-        def list_executions(function_id:, queries: nil)
+        def list_executions(function_id:, queries: nil, total: nil)
             api_path = '/functions/{functionId}/executions'
                 .gsub('{functionId}', function_id)
 
@@ -709,6 +714,7 @@ module Appwrite
 
             api_params = {
                 queries: queries,
+                total: total,
             }
             
             api_headers = {