appwrite 30.0.1 → 30.2.0

data/lib/appwrite/services/proxy.rb

@@ -337,7 +337,7 @@ module Appwrite
             end
 
             api_path = '/proxy/rules/{ruleId}'
-                .gsub('{ruleId}', rule_id)
+                .gsub('{ruleId}', @client.encode_path(rule_id))
 
             api_params = {}
 
@@ -368,7 +368,7 @@ module Appwrite
             end
 
             api_path = '/proxy/rules/{ruleId}'
-                .gsub('{ruleId}', rule_id)
+                .gsub('{ruleId}', @client.encode_path(rule_id))
 
             api_params = {}
 
@@ -386,10 +386,163 @@ module Appwrite
             )
         end
 
+        # Update the function and VCS branch a function proxy rule executes. The rule
+        # domain cannot be changed.
+        #
+        # @param [String] rule_id Rule ID.
+        # @param [String] function_id ID of function to be executed.
+        # @param [String] branch Name of VCS branch to deploy changes automatically
+        #
+        # @return [ProxyRule]
+        def update_function_rule(
+            rule_id:,
+            function_id:,
+            branch: nil
+        )
+            if rule_id.nil? || rule_id == ''
+                raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
+            end
+
+            if function_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "functionId"')
+            end
+
+            api_path = '/proxy/rules/{ruleId}/function'
+                .gsub('{ruleId}', @client.encode_path(rule_id))
+
+            api_params = {
+                functionId: function_id,
+                branch: branch,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+        end
+
+        # Update the target URL, status code and parent resource of a redirect proxy
+        # rule. The rule domain cannot be changed.
+        #
+        # @param [String] rule_id Rule ID.
+        # @param [String] url Target URL of redirection
+        # @param [StatusCode] status_code Status code of redirection
+        # @param [String] resource_id ID of parent resource.
+        # @param [ProxyResourceType] resource_type Type of parent resource.
+        #
+        # @return [ProxyRule]
+        def update_redirect_rule(
+            rule_id:,
+            url:,
+            status_code:,
+            resource_id:,
+            resource_type:
+        )
+            if rule_id.nil? || rule_id == ''
+                raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
+            end
+
+            if url.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "url"')
+            end
+
+            if status_code.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "statusCode"')
+            end
+
+            if resource_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "resourceId"')
+            end
+
+            if resource_type.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "resourceType"')
+            end
+
+            api_path = '/proxy/rules/{ruleId}/redirect'
+                .gsub('{ruleId}', @client.encode_path(rule_id))
+
+            api_params = {
+                url: url,
+                statusCode: status_code,
+                resourceId: resource_id,
+                resourceType: resource_type,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+        end
+
+        # Update the site and VCS branch a site proxy rule serves. The rule domain
+        # cannot be changed.
+        #
+        # @param [String] rule_id Rule ID.
+        # @param [String] site_id ID of site to be executed.
+        # @param [String] branch Name of VCS branch to deploy changes automatically
+        #
+        # @return [ProxyRule]
+        def update_site_rule(
+            rule_id:,
+            site_id:,
+            branch: nil
+        )
+            if rule_id.nil? || rule_id == ''
+                raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
+            end
+
+            if site_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "siteId"')
+            end
+
+            api_path = '/proxy/rules/{ruleId}/site'
+                .gsub('{ruleId}', @client.encode_path(rule_id))
+
+            api_params = {
+                siteId: site_id,
+                branch: branch,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+        end
+
         # If not succeeded yet, retry verification process of a proxy rule domain.
         # This endpoint triggers domain verification by checking DNS records. If
         # verification is successful, a TLS certificate will be automatically
-        # provisioned for the domain asynchronously in the background.
+        # provisioned for the domain asynchronously in the background. A verified
+        # rule whose certificate renewal failed or is blocked, or whose certificate
+        # expired, is checked the same way, and its certificate renewed in the
+        # background.
         #
         # @param [String] rule_id Rule ID.
         #
@@ -402,7 +555,7 @@ module Appwrite
             end
 
             api_path = '/proxy/rules/{ruleId}/status'
-                .gsub('{ruleId}', rule_id)
+                .gsub('{ruleId}', @client.encode_path(rule_id))
 
             api_params = {}
 

data/lib/appwrite/services/sites.rb

@@ -65,7 +65,7 @@ module Appwrite
         # @param [Array] provider_paths List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.
         # @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.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 keeps all deployments unless the server applies a default retention.
         # @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.
         #
@@ -231,7 +231,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {}
 
@@ -273,7 +273,7 @@ module Appwrite
         # @param [Array] provider_paths List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.
         # @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.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 keeps all deployments unless the server applies a default retention.
         # @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.
         #
@@ -318,7 +318,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 name: name,
@@ -375,7 +375,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {}
 
@@ -413,7 +413,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployment'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 deploymentId: deployment_id,
@@ -454,7 +454,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 queries: queries,
@@ -506,7 +506,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 installCommand: install_command,
@@ -560,7 +560,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/duplicate'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 deploymentId: deployment_id,
@@ -630,7 +630,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/template'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 repository: repository,
@@ -685,7 +685,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/vcs'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 type: type,
@@ -727,8 +727,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {}
 
@@ -765,8 +765,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {}
 
@@ -809,8 +809,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}/download'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {
                 type: type,
@@ -853,8 +853,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/deployments/{deploymentId}/status'
-                .gsub('{siteId}', site_id)
-                .gsub('{deploymentId}', deployment_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{deploymentId}', @client.encode_path(deployment_id))
 
             api_params = {}
 
@@ -891,7 +891,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/logs'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 queries: queries,
@@ -931,8 +931,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/logs/{logId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{logId}', log_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{logId}', @client.encode_path(log_id))
 
             api_params = {}
 
@@ -969,8 +969,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/logs/{logId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{logId}', log_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{logId}', @client.encode_path(log_id))
 
             api_params = {}
 
@@ -1005,7 +1005,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 queries: queries,
@@ -1062,7 +1062,7 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables'
-                .gsub('{siteId}', site_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
 
             api_params = {
                 variableId: variable_id,
@@ -1106,8 +1106,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {}
 
@@ -1152,8 +1152,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {
                 key: key,
@@ -1196,8 +1196,8 @@ module Appwrite
             end
 
             api_path = '/sites/{siteId}/variables/{variableId}'
-                .gsub('{siteId}', site_id)
-                .gsub('{variableId}', variable_id)
+                .gsub('{siteId}', @client.encode_path(site_id))
+                .gsub('{variableId}', @client.encode_path(variable_id))
 
             api_params = {}
 

data/lib/appwrite/services/storage.rb

@@ -51,7 +51,7 @@ module Appwrite
         # @param [Integer] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 5GB.
         # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
         # @param [Compression] compression Compression algorithm chosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
-        # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
+        # @param [] encryption Is encryption enabled? Files of any size are encrypted.
         # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         # @param [] transformations Are image transformations enabled?
         # @param [String] description Optional description for the bucket.
@@ -128,7 +128,7 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}'
-                .gsub('{bucketId}', bucket_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
 
             api_params = {}
 
@@ -156,7 +156,7 @@ module Appwrite
         # @param [Integer] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 5GB.
         # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
         # @param [Compression] compression Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
-        # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
+        # @param [] encryption Is encryption enabled? Files of any size are encrypted.
         # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
         # @param [] transformations Are image transformations enabled?
         # @param [String] description Optional description for the bucket.
@@ -187,7 +187,7 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}'
-                .gsub('{bucketId}', bucket_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
 
             api_params = {
                 name: name,
@@ -232,7 +232,7 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}'
-                .gsub('{bucketId}', bucket_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
 
             api_params = {}
 
@@ -270,7 +270,7 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files'
-                .gsub('{bucketId}', bucket_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
 
             api_params = {
                 queries: queries,
@@ -339,7 +339,7 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files'
-                .gsub('{bucketId}', bucket_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
 
             api_params = {
                 fileId: file_id,
@@ -389,8 +389,8 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files/{fileId}'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
+                .gsub('{fileId}', @client.encode_path(file_id))
 
             api_params = {}
 
@@ -432,8 +432,8 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files/{fileId}'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
+                .gsub('{fileId}', @client.encode_path(file_id))
 
             api_params = {
                 name: name,
@@ -475,8 +475,8 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files/{fileId}'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
+                .gsub('{fileId}', @client.encode_path(file_id))
 
             api_params = {}
 
@@ -517,8 +517,8 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files/{fileId}/download'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
+                .gsub('{fileId}', @client.encode_path(file_id))
 
             api_params = {
                 token: token,
@@ -584,8 +584,8 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files/{fileId}/preview'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
+                .gsub('{fileId}', @client.encode_path(file_id))
 
             api_params = {
                 width: width,
@@ -638,8 +638,8 @@ module Appwrite
             end
 
             api_path = '/storage/buckets/{bucketId}/files/{fileId}/view'
-                .gsub('{bucketId}', bucket_id)
-                .gsub('{fileId}', file_id)
+                .gsub('{bucketId}', @client.encode_path(bucket_id))
+                .gsub('{fileId}', @client.encode_path(file_id))
 
             api_params = {
                 token: token,