appwrite 28.3.2 → 29.0.0

data/lib/appwrite/services/proxy.rb

@@ -12,6 +12,8 @@ module Appwrite
         # Depending on type, the invalidation purges a single cache tag, a single URL
         # path, or all cached content for the domain.
         #
+        # Domains that route to a function do not support cache invalidation.
+        #
         # @param [String] domain Domain name.
         # @param [InvalidationType] type Type of reference passed. Allowed values are: tag, path, all
         # @param [String] reference Reference to invalidate. Depending on type this can be: cache tag name (up to 128 characters), URL path (up to 2048 characters). Not required when type is all.
@@ -22,8 +24,6 @@ module Appwrite
             type:,
             reference: nil
         )
-            api_path = '/proxy/invalidations'
-
             if domain.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "domain"')
             end
@@ -32,6 +32,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "type"')
             end
 
+            api_path = '/proxy/invalidations'
+
             api_params = {
                 domain: domain,
                 type: type,
@@ -56,7 +58,7 @@ module Appwrite
         # Get a list of all the proxy rules. 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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
+        # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch, protocol
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [ProxyRuleList]
@@ -96,12 +98,12 @@ module Appwrite
         def create_api_rule(
             domain:
         )
-            api_path = '/proxy/rules/api'
-
             if domain.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "domain"')
             end
 
+            api_path = '/proxy/rules/api'
+
             api_params = {
                 domain: domain,
             }
@@ -136,8 +138,6 @@ module Appwrite
             function_id:,
             branch: nil
         )
-            api_path = '/proxy/rules/function'
-
             if domain.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "domain"')
             end
@@ -146,6 +146,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "functionId"')
             end
 
+            api_path = '/proxy/rules/function'
+
             api_params = {
                 domain: domain,
                 functionId: function_id,
@@ -187,8 +189,6 @@ module Appwrite
             resource_id:,
             resource_type:
         )
-            api_path = '/proxy/rules/redirect'
-
             if domain.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "domain"')
             end
@@ -209,6 +209,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "resourceType"')
             end
 
+            api_path = '/proxy/rules/redirect'
+
             api_params = {
                 domain: domain,
                 url: url,
@@ -247,8 +249,6 @@ module Appwrite
             site_id:,
             branch: nil
         )
-            api_path = '/proxy/rules/site'
-
             if domain.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "domain"')
             end
@@ -257,6 +257,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
+            api_path = '/proxy/rules/site'
+
             api_params = {
                 domain: domain,
                 siteId: site_id,
@@ -278,6 +280,50 @@ module Appwrite
             )
         end
 
+        # Create an SMTP ingress rule that asynchronously executes an Appwrite
+        # Function for incoming email.
+        #
+        # @param [String] domain Domain that receives email.
+        # @param [String] function_id ID of function to execute.
+        # @param [String] branch Name of VCS branch to deploy changes automatically.
+        #
+        # @return [ProxyRule]
+        def create_smtp_rule(
+            domain:,
+            function_id:,
+            branch: nil
+        )
+            if domain.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "domain"')
+            end
+
+            if function_id.nil?
+                raise Appwrite::Exception.new('Missing required parameter: "functionId"')
+            end
+
+            api_path = '/proxy/rules/smtp'
+
+            api_params = {
+                domain: domain,
+                functionId: function_id,
+                branch: branch,
+            }
+
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+        end
+
         # Get a proxy rule by its unique ID.
         #
         # @param [String] rule_id Rule ID.
@@ -286,13 +332,13 @@ module Appwrite
         def get_rule(
             rule_id:
         )
-            api_path = '/proxy/rules/{ruleId}'
-                .gsub('{ruleId}', rule_id)
-
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
+            api_path = '/proxy/rules/{ruleId}'
+                .gsub('{ruleId}', rule_id)
+
             api_params = {}
 
             api_headers = {
@@ -317,18 +363,19 @@ module Appwrite
         def delete_rule(
             rule_id:
         )
-            api_path = '/proxy/rules/{ruleId}'
-                .gsub('{ruleId}', rule_id)
-
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
+            api_path = '/proxy/rules/{ruleId}'
+                .gsub('{ruleId}', rule_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -350,13 +397,13 @@ module Appwrite
         def update_rule_status(
             rule_id:
         )
-            api_path = '/proxy/rules/{ruleId}/status'
-                .gsub('{ruleId}', rule_id)
-
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
+            api_path = '/proxy/rules/{ruleId}/status'
+                .gsub('{ruleId}', rule_id)
+
             api_params = {}
 
             api_headers = {