appwrite 21.1.0 → 22.0.0

data/lib/appwrite/services/health.rb

@@ -195,54 +195,6 @@ module Appwrite
             )
         end
 
-        # Get billing project aggregation queue.
-        #
-        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
-        #
-        # @return [HealthQueue]
-        def get_queue_billing_project_aggregation(threshold: nil)
-            api_path = '/health/queue/billing-project-aggregation'
-
-            api_params = {
-                threshold: threshold,
-            }
-            
-            api_headers = {
-            }
-
-            @client.call(
-                method: 'GET',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::HealthQueue
-            )
-        end
-
-        # Get billing team aggregation queue.
-        #
-        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
-        #
-        # @return [HealthQueue]
-        def get_queue_billing_team_aggregation(threshold: nil)
-            api_path = '/health/queue/billing-team-aggregation'
-
-            api_params = {
-                threshold: threshold,
-            }
-            
-            api_headers = {
-            }
-
-            @client.call(
-                method: 'GET',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::HealthQueue
-            )
-        end
-
         # Get the number of builds that are waiting to be processed in the Appwrite
         # internal queue server.
         #
@@ -268,30 +220,6 @@ module Appwrite
             )
         end
 
-        # Get the priority builds queue size.
-        #
-        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
-        #
-        # @return [HealthQueue]
-        def get_queue_priority_builds(threshold: nil)
-            api_path = '/health/queue/builds-priority'
-
-            api_params = {
-                threshold: threshold,
-            }
-            
-            api_headers = {
-            }
-
-            @client.call(
-                method: 'GET',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::HealthQueue
-            )
-        end
-
         # Get the number of certificates that are waiting to be issued against
         # [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
         # server.
@@ -526,30 +454,6 @@ module Appwrite
             )
         end
 
-        # Get region manager queue.
-        #
-        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
-        #
-        # @return [HealthQueue]
-        def get_queue_region_manager(threshold: nil)
-            api_path = '/health/queue/region-manager'
-
-            api_params = {
-                threshold: threshold,
-            }
-            
-            api_headers = {
-            }
-
-            @client.call(
-                method: 'GET',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::HealthQueue
-            )
-        end
-
         # Get the number of metrics that are waiting to be processed in the Appwrite
         # stats resources queue.
         #
@@ -600,30 +504,6 @@ module Appwrite
             )
         end
 
-        # Get threats queue.
-        #
-        # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
-        #
-        # @return [HealthQueue]
-        def get_queue_threats(threshold: nil)
-            api_path = '/health/queue/threats'
-
-            api_params = {
-                threshold: threshold,
-            }
-            
-            api_headers = {
-            }
-
-            @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.
         #

data/lib/appwrite/services/project.rb

@@ -0,0 +1,172 @@
+#frozen_string_literal: true
+
+module Appwrite
+    class Project < Service
+
+        def initialize(client)
+            @client = client
+        end
+
+        # Get a list of all project environment variables.
+        #
+        # @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, resourceType, resourceId, secret
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
+        #
+        # @return [VariableList]
+        def list_variables(queries: nil, total: nil)
+            api_path = '/project/variables'
+
+            api_params = {
+                queries: queries,
+                total: total,
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::VariableList
+            )
+        end
+
+        # Create a new project environment variable. These variables can be accessed
+        # by all functions and sites in the project.
+        #
+        # @param [String] variable_id Variable 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] key Variable key. Max length: 255 chars.
+        # @param [String] value Variable value. Max length: 8192 chars.
+        # @param [] secret Secret variables can be updated or deleted, but only projects can read them during build and runtime.
+        #
+        # @return [Variable]
+        def create_variable(variable_id:, key:, value:, secret: nil)
+            api_path = '/project/variables'
+
+            if variable_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "variableId"')
+            end
+
+            if key.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "key"')
+            end
+
+            if value.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "value"')
+            end
+
+            api_params = {
+                variableId: variable_id,
+                key: key,
+                value: value,
+                secret: secret,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Variable
+            )
+        end
+
+        # Get a variable by its unique ID. 
+        #
+        # @param [String] variable_id Variable ID.
+        #
+        # @return [Variable]
+        def get_variable(variable_id:)
+            api_path = '/project/variables/{variableId}'
+                .gsub('{variableId}', variable_id)
+
+            if variable_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "variableId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Variable
+            )
+        end
+
+        # Update variable by its unique ID.
+        #
+        # @param [String] variable_id Variable ID.
+        # @param [String] key Variable key. Max length: 255 chars.
+        # @param [String] value Variable value. Max length: 8192 chars.
+        # @param [] secret Secret variables can be updated or deleted, but only projects can read them during build and runtime.
+        #
+        # @return [Variable]
+        def update_variable(variable_id:, key: nil, value: nil, secret: nil)
+            api_path = '/project/variables/{variableId}'
+                .gsub('{variableId}', variable_id)
+
+            if variable_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "variableId"')
+            end
+
+            api_params = {
+                key: key,
+                value: value,
+                secret: secret,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::Variable
+            )
+        end
+
+        # Delete a variable by its unique ID. 
+        #
+        # @param [String] variable_id Variable ID.
+        #
+        # @return []
+        def delete_variable(variable_id:)
+            api_path = '/project/variables/{variableId}'
+                .gsub('{variableId}', variable_id)
+
+            if variable_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "variableId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+        end
+
+    end 
+end

data/lib/appwrite/services/sites.rb

@@ -47,6 +47,7 @@ module Appwrite
         # @param [Integer] timeout Maximum request time in seconds.
         # @param [String] install_command Install Command.
         # @param [String] build_command Build Command.
+        # @param [String] start_command Custom start command. Leave empty to use default.
         # @param [String] output_directory Output Directory for site.
         # @param [Adapter] adapter Framework adapter defining rendering strategy. Allowed values are: static, ssr
         # @param [String] installation_id Appwrite Installation ID for VCS (Version Control System) deployment.
@@ -55,10 +56,12 @@ module Appwrite
         # @param [String] provider_branch Production branch for the repo linked to the site.
         # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
         # @param [String] provider_root_directory Path to site code in the linked repo.
-        # @param [String] specification Framework specification for the site and builds.
+        # @param [String] build_specification Build specification for the site deployments.
+        # @param [String] runtime_specification Runtime specification for the SSR executions.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
         #
         # @return [Site]
-        def create(site_id:, name:, framework:, build_runtime:, enabled: nil, logging: nil, timeout: nil, install_command: nil, build_command: nil, output_directory: nil, adapter: nil, installation_id: nil, fallback_file: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, specification: nil)
+        def create(site_id:, name:, framework:, build_runtime:, enabled: nil, logging: nil, timeout: nil, install_command: nil, build_command: nil, start_command: nil, output_directory: nil, adapter: nil, installation_id: nil, fallback_file: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/sites'
 
             if site_id.nil?
@@ -86,6 +89,7 @@ module Appwrite
                 timeout: timeout,
                 installCommand: install_command,
                 buildCommand: build_command,
+                startCommand: start_command,
                 outputDirectory: output_directory,
                 buildRuntime: build_runtime,
                 adapter: adapter,
@@ -95,7 +99,9 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
-                specification: specification,
+                buildSpecification: build_specification,
+                runtimeSpecification: runtime_specification,
+                deploymentRetention: deployment_retention,
             }
             
             api_headers = {
@@ -194,6 +200,7 @@ module Appwrite
         # @param [Integer] timeout Maximum request time in seconds.
         # @param [String] install_command Install Command.
         # @param [String] build_command Build Command.
+        # @param [String] start_command Custom start command. Leave empty to use default.
         # @param [String] output_directory Output Directory for site.
         # @param [BuildRuntime] build_runtime Runtime to use during build step.
         # @param [Adapter] adapter Framework adapter defining rendering strategy. Allowed values are: static, ssr
@@ -203,10 +210,12 @@ module Appwrite
         # @param [String] provider_branch Production branch for the repo linked to the site.
         # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
         # @param [String] provider_root_directory Path to site code in the linked repo.
-        # @param [String] specification Framework specification for the site and builds.
+        # @param [String] build_specification Build specification for the site deployments.
+        # @param [String] runtime_specification Runtime specification for the SSR executions.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
         #
         # @return [Site]
-        def update(site_id:, name:, framework:, enabled: nil, logging: nil, timeout: nil, install_command: nil, build_command: nil, output_directory: nil, build_runtime: nil, adapter: nil, fallback_file: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, specification: nil)
+        def update(site_id:, name:, framework:, enabled: nil, logging: nil, timeout: nil, install_command: nil, build_command: nil, start_command: nil, output_directory: nil, build_runtime: nil, adapter: nil, fallback_file: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/sites/{siteId}'
                 .gsub('{siteId}', site_id)
 
@@ -230,6 +239,7 @@ module Appwrite
                 timeout: timeout,
                 installCommand: install_command,
                 buildCommand: build_command,
+                startCommand: start_command,
                 outputDirectory: output_directory,
                 buildRuntime: build_runtime,
                 adapter: adapter,
@@ -239,7 +249,9 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
-                specification: specification,
+                buildSpecification: build_specification,
+                runtimeSpecification: runtime_specification,
+                deploymentRetention: deployment_retention,
             }
             
             api_headers = {

data/lib/appwrite/services/tables_db.rb

@@ -2582,7 +2582,7 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] table_id Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
         # @param [String] key Index Key.
-        # @param [IndexType] type Index type.
+        # @param [TablesDBIndexType] type Index type.
         # @param [Array] columns Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
         # @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
         # @param [Array] lengths Length of index. Maximum of 100

data/lib/appwrite/services/users.rb

@@ -10,7 +10,7 @@ module Appwrite
         # Get a list of all the project's users. You can use the query params to
         # filter your results.
         #
-        # @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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
+        # @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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator
         # @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.
         #
@@ -598,6 +598,46 @@ module Appwrite
             )
         end
 
+        # Enable or disable whether a user can impersonate other users. When
+        # impersonation headers are used, the request runs as the target user for API
+        # behavior, while internal audit logs still attribute the action to the
+        # original impersonator and store the impersonated target details only in
+        # internal audit payload data.
+        # 
+        #
+        # @param [String] user_id User ID.
+        # @param [] impersonator Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.
+        #
+        # @return [User]
+        def update_impersonator(user_id:, impersonator:)
+            api_path = '/users/{userId}/impersonator'
+                .gsub('{userId}', user_id)
+
+            if user_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "userId"')
+            end
+
+            if impersonator.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "impersonator"')
+            end
+
+            api_params = {
+                impersonator: impersonator,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::User
+            )
+        end
+
         # Use this endpoint to create a JSON Web Token for user by its unique ID. You
         # can use the resulting JWT to authenticate on behalf of the user. The JWT
         # secret will become invalid if the session it uses gets deleted.