appwrite 28.4.0 → 30.0.0

data/lib/appwrite/services/sites.rb

@@ -67,6 +67,7 @@ module Appwrite
         # @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.
         # @param [Array] scopes List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
+        # @param [String] description Optional description for the site.
         #
         # @return [Site]
         def create(
@@ -93,10 +94,9 @@ module Appwrite
             build_specification: nil,
             runtime_specification: nil,
             deployment_retention: nil,
-            scopes: nil
+            scopes: nil,
+            description: nil
         )
-            api_path = '/sites'
-
             if site_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
@@ -113,6 +113,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "buildRuntime"')
             end
 
+            api_path = '/sites'
+
             api_params = {
                 siteId: site_id,
                 name: name,
@@ -138,6 +140,7 @@ module Appwrite
                 runtimeSpecification: runtime_specification,
                 deploymentRetention: deployment_retention,
                 scopes: scopes,
+                description: description,
             }
 
             api_headers = {
@@ -223,13 +226,13 @@ module Appwrite
         def get(
             site_id:
         )
-            api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
+            api_path = '/sites/{siteId}'
+                .gsub('{siteId}', site_id)
+
             api_params = {}
 
             api_headers = {
@@ -272,6 +275,7 @@ module Appwrite
         # @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.
         # @param [Array] scopes List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
+        # @param [String] description Optional description for the site.
         #
         # @return [Site]
         def update(
@@ -298,12 +302,10 @@ module Appwrite
             build_specification: nil,
             runtime_specification: nil,
             deployment_retention: nil,
-            scopes: nil
+            scopes: nil,
+            description: nil
         )
-            api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
@@ -315,6 +317,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "framework"')
             end
 
+            api_path = '/sites/{siteId}'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 name: name,
                 framework: framework,
@@ -339,6 +344,7 @@ module Appwrite
                 runtimeSpecification: runtime_specification,
                 deploymentRetention: deployment_retention,
                 scopes: scopes,
+                description: description,
             }
 
             api_headers = {
@@ -364,18 +370,19 @@ module Appwrite
         def delete(
             site_id:
         )
-            api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
+            api_path = '/sites/{siteId}'
+                .gsub('{siteId}', site_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -397,10 +404,7 @@ module Appwrite
             site_id:,
             deployment_id:
         )
-            api_path = '/sites/{siteId}/deployment'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
@@ -408,6 +412,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
+            api_path = '/sites/{siteId}/deployment'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 deploymentId: deployment_id,
             }
@@ -442,13 +449,13 @@ module Appwrite
             search: nil,
             total: nil
         )
-            api_path = '/sites/{siteId}/deployments'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
+            api_path = '/sites/{siteId}/deployments'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 queries: queries,
                 search: search,
@@ -490,10 +497,7 @@ module Appwrite
             activate: nil,
             on_progress: nil
         )
-            api_path = '/sites/{siteId}/deployments'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
@@ -501,6 +505,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "code"')
             end
 
+            api_path = '/sites/{siteId}/deployments'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 installCommand: install_command,
                 buildCommand: build_command,
@@ -525,6 +532,7 @@ module Appwrite
                 param_name: param_name,
                 id_param_name: id_param_name,
                 on_progress: on_progress,
+                method: 'POST',
                 response_type: Models::Deployment
             )
         end
@@ -543,10 +551,7 @@ module Appwrite
             site_id:,
             deployment_id:
         )
-            api_path = '/sites/{siteId}/deployments/duplicate'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
@@ -554,6 +559,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
+            api_path = '/sites/{siteId}/deployments/duplicate'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 deploymentId: deployment_id,
             }
@@ -597,10 +605,7 @@ module Appwrite
             reference:,
             activate: nil
         )
-            api_path = '/sites/{siteId}/deployments/template'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
@@ -624,6 +629,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "reference"')
             end
 
+            api_path = '/sites/{siteId}/deployments/template'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 repository: repository,
                 owner: owner,
@@ -664,10 +672,7 @@ module Appwrite
             reference:,
             activate: nil
         )
-            api_path = '/sites/{siteId}/deployments/vcs'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
@@ -679,6 +684,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "reference"')
             end
 
+            api_path = '/sites/{siteId}/deployments/vcs'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 type: type,
                 reference: reference,
@@ -710,18 +718,18 @@ module Appwrite
             site_id:,
             deployment_id:
         )
-            api_path = '/sites/{siteId}/deployments/{deploymentId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if deployment_id.nil?
+            if deployment_id.nil? || deployment_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
+            api_path = '/sites/{siteId}/deployments/{deploymentId}'
+                .gsub('{siteId}', site_id)
+                .gsub('{deploymentId}', deployment_id)
+
             api_params = {}
 
             api_headers = {
@@ -748,23 +756,24 @@ module Appwrite
             site_id:,
             deployment_id:
         )
-            api_path = '/sites/{siteId}/deployments/{deploymentId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if deployment_id.nil?
+            if deployment_id.nil? || deployment_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
+            api_path = '/sites/{siteId}/deployments/{deploymentId}'
+                .gsub('{siteId}', site_id)
+                .gsub('{deploymentId}', deployment_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -791,18 +800,18 @@ module Appwrite
             type: nil,
             token: nil
         )
-            api_path = '/sites/{siteId}/deployments/{deploymentId}/download'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if deployment_id.nil?
+            if deployment_id.nil? || deployment_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
+            api_path = '/sites/{siteId}/deployments/{deploymentId}/download'
+                .gsub('{siteId}', site_id)
+                .gsub('{deploymentId}', deployment_id)
+
             api_params = {
                 type: type,
                 token: token,
@@ -835,18 +844,18 @@ module Appwrite
             site_id:,
             deployment_id:
         )
-            api_path = '/sites/{siteId}/deployments/{deploymentId}/status'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if deployment_id.nil?
+            if deployment_id.nil? || deployment_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
             end
 
+            api_path = '/sites/{siteId}/deployments/{deploymentId}/status'
+                .gsub('{siteId}', site_id)
+                .gsub('{deploymentId}', deployment_id)
+
             api_params = {}
 
             api_headers = {
@@ -877,13 +886,13 @@ module Appwrite
             queries: nil,
             total: nil
         )
-            api_path = '/sites/{siteId}/logs'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
+            api_path = '/sites/{siteId}/logs'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 queries: queries,
                 total: total,
@@ -913,18 +922,18 @@ module Appwrite
             site_id:,
             log_id:
         )
-            api_path = '/sites/{siteId}/logs/{logId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{logId}', log_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if log_id.nil?
+            if log_id.nil? || log_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "logId"')
             end
 
+            api_path = '/sites/{siteId}/logs/{logId}'
+                .gsub('{siteId}', site_id)
+                .gsub('{logId}', log_id)
+
             api_params = {}
 
             api_headers = {
@@ -951,18 +960,18 @@ module Appwrite
             site_id:,
             log_id:
         )
-            api_path = '/sites/{siteId}/logs/{logId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{logId}', log_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if log_id.nil?
+            if log_id.nil? || log_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "logId"')
             end
 
+            api_path = '/sites/{siteId}/logs/{logId}'
+                .gsub('{siteId}', site_id)
+                .gsub('{logId}', log_id)
+
             api_params = {}
 
             api_headers = {
@@ -991,13 +1000,13 @@ module Appwrite
             queries: nil,
             total: nil
         )
-            api_path = '/sites/{siteId}/variables'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
+            api_path = '/sites/{siteId}/variables'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 queries: queries,
                 total: total,
@@ -1025,6 +1034,7 @@ module Appwrite
         # @param [String] key Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
         # @param [String] value Variable value. Max length: 8192 chars.
         # @param [] secret Secret variables can be updated or deleted, but only sites can read them during build and runtime.
+        # @param [String] description Optional description for the variable.
         #
         # @return [Variable]
         def create_variable(
@@ -1032,12 +1042,10 @@ module Appwrite
             variable_id:,
             key:,
             value:,
-            secret: nil
+            secret: nil,
+            description: nil
         )
-            api_path = '/sites/{siteId}/variables'
-                .gsub('{siteId}', site_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
@@ -1053,11 +1061,15 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "value"')
             end
 
+            api_path = '/sites/{siteId}/variables'
+                .gsub('{siteId}', site_id)
+
             api_params = {
                 variableId: variable_id,
                 key: key,
                 value: value,
                 secret: secret,
+                description: description,
             }
 
             api_headers = {
@@ -1085,18 +1097,18 @@ module Appwrite
             site_id:,
             variable_id:
         )
-            api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if variable_id.nil?
+            if variable_id.nil? || variable_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "variableId"')
             end
 
+            api_path = '/sites/{siteId}/variables/{variableId}'
+                .gsub('{siteId}', site_id)
+                .gsub('{variableId}', variable_id)
+
             api_params = {}
 
             api_headers = {
@@ -1120,6 +1132,7 @@ module Appwrite
         # @param [String] key Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
         # @param [String] value Variable value. Max length: 8192 chars.
         # @param [] secret Secret variables can be updated or deleted, but only sites can read them during build and runtime.
+        # @param [String] description Optional description for the variable.
         #
         # @return [Variable]
         def update_variable(
@@ -1127,24 +1140,26 @@ module Appwrite
             variable_id:,
             key: nil,
             value: nil,
-            secret: nil
+            secret: nil,
+            description: nil
         )
-            api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if variable_id.nil?
+            if variable_id.nil? || variable_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "variableId"')
             end
 
+            api_path = '/sites/{siteId}/variables/{variableId}'
+                .gsub('{siteId}', site_id)
+                .gsub('{variableId}', variable_id)
+
             api_params = {
                 key: key,
                 value: value,
                 secret: secret,
+                description: description,
             }
 
             api_headers = {
@@ -1172,23 +1187,24 @@ module Appwrite
             site_id:,
             variable_id:
         )
-            api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
-
-            if site_id.nil?
+            if site_id.nil? || site_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
-            if variable_id.nil?
+            if variable_id.nil? || variable_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "variableId"')
             end
 
+            api_path = '/sites/{siteId}/variables/{variableId}'
+                .gsub('{siteId}', site_id)
+                .gsub('{variableId}', variable_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(