appwrite 22.0.0 → 23.1.0

data/lib/appwrite/services/proxy.rb

@@ -0,0 +1,303 @@
+#frozen_string_literal: true
+
+module Appwrite
+    class Proxy < Service
+
+        def initialize(client)
+            @client = client
+        end
+
+        # 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 [] total When set to false, the total count returned will be 0 and will not be calculated.
+        #
+        # @return [ProxyRuleList]
+        def list_rules(queries: nil, total: nil)
+            api_path = '/proxy/rules'
+
+            api_params = {
+                queries: queries,
+                total: total,
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRuleList
+            )
+
+        end
+
+        # Create a new proxy rule for serving Appwrite's API on custom domain.
+        # 
+        # Rule ID is automatically generated as MD5 hash of a rule domain for
+        # performance purposes.
+        #
+        # @param [String] domain Domain name.
+        #
+        # @return [ProxyRule]
+        def create_api_rule(domain:)
+            api_path = '/proxy/rules/api'
+
+            if domain.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "domain"')
+            end
+
+            api_params = {
+                domain: domain,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+
+        end
+
+        # Create a new proxy rule for executing Appwrite Function on custom domain.
+        # 
+        # Rule ID is automatically generated as MD5 hash of a rule domain for
+        # performance purposes.
+        #
+        # @param [String] domain Domain name.
+        # @param [String] function_id ID of function to be executed.
+        # @param [String] branch Name of VCS branch to deploy changes automatically
+        #
+        # @return [ProxyRule]
+        def create_function_rule(domain:, function_id:, branch: nil)
+            api_path = '/proxy/rules/function'
+
+            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_params = {
+                domain: domain,
+                functionId: function_id,
+                branch: branch,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+
+        end
+
+        # Create a new proxy rule for to redirect from custom domain to another
+        # domain.
+        # 
+        # Rule ID is automatically generated as MD5 hash of a rule domain for
+        # performance purposes.
+        #
+        # @param [String] domain Domain name.
+        # @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 create_redirect_rule(domain:, url:, status_code:, resource_id:, resource_type:)
+            api_path = '/proxy/rules/redirect'
+
+            if domain.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "domain"')
+            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_params = {
+                domain: domain,
+                url: url,
+                statusCode: status_code,
+                resourceId: resource_id,
+                resourceType: resource_type,
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'POST',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+
+        end
+
+        # Create a new proxy rule for serving Appwrite Site on custom domain.
+        # 
+        # Rule ID is automatically generated as MD5 hash of a rule domain for
+        # performance purposes.
+        #
+        # @param [String] domain Domain name.
+        # @param [String] site_id ID of site to be executed.
+        # @param [String] branch Name of VCS branch to deploy changes automatically
+        #
+        # @return [ProxyRule]
+        def create_site_rule(domain:, site_id:, branch: nil)
+            api_path = '/proxy/rules/site'
+
+            if domain.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "domain"')
+            end
+
+            if site_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "siteId"')
+            end
+
+            api_params = {
+                domain: domain,
+                siteId: site_id,
+                branch: branch,
+            }
+            
+            api_headers = {
+                "content-type": '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.
+        #
+        # @return [ProxyRule]
+        def get_rule(rule_id:)
+            api_path = '/proxy/rules/{ruleId}'
+                .gsub('{ruleId}', rule_id)
+
+            if rule_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+
+        end
+
+        # Delete a proxy rule by its unique ID.
+        #
+        # @param [String] rule_id Rule ID.
+        #
+        # @return []
+        def delete_rule(rule_id:)
+            api_path = '/proxy/rules/{ruleId}'
+                .gsub('{ruleId}', rule_id)
+
+            if rule_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+
+        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.
+        #
+        # @param [String] rule_id Rule ID.
+        #
+        # @return [ProxyRule]
+        def update_rule_status(rule_id:)
+            api_path = '/proxy/rules/{ruleId}/status'
+                .gsub('{ruleId}', rule_id)
+
+            if rule_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "content-type": 'application/json',
+            }
+
+            @client.call(
+                method: 'PATCH',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::ProxyRule
+            )
+
+        end
+
+    end 
+end

data/lib/appwrite/services/sites.rb

@@ -34,6 +34,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::SiteList
             )
+
         end
 
         # Create a new site.
@@ -115,6 +116,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Site
             )
+
         end
 
         # Get a list of all frameworks that are currently available on the server
@@ -138,6 +140,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::FrameworkList
             )
+
         end
 
         # List allowed site specifications for this instance.
@@ -160,6 +163,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::SpecificationList
             )
+
         end
 
         # Get a site by its unique ID.
@@ -188,6 +192,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Site
             )
+
         end
 
         # Update site by its unique ID.
@@ -265,6 +270,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Site
             )
+
         end
 
         # Delete a site by its unique ID.
@@ -293,6 +299,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Update the site active deployment. Use this endpoint to switch the code
@@ -329,6 +336,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Site
             )
+
         end
 
         # Get a list of all the site's code deployments. You can use the query params
@@ -364,6 +372,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::DeploymentList
             )
+
         end
 
         # Create a new site code deployment. Use this endpoint to upload a new
@@ -414,6 +423,7 @@ module Appwrite
                 on_progress: on_progress,
                 response_type: Models::Deployment
             )
+
         end
 
         # Create a new build for an existing site deployment. This endpoint allows
@@ -453,6 +463,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Deployment
             )
+
         end
 
         # Create a deployment based on a template.
@@ -518,6 +529,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Deployment
             )
+
         end
 
         # Create a deployment when a site is connected to VCS.
@@ -563,6 +575,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Deployment
             )
+
         end
 
         # Get a site deployment by its unique ID.
@@ -597,6 +610,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Deployment
             )
+
         end
 
         # Delete a site deployment by its unique ID.
@@ -631,6 +645,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Get a site deployment content by its unique ID. The endpoint response
@@ -668,6 +683,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Cancel an ongoing site deployment build. If the build is already in
@@ -707,6 +723,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Deployment
             )
+
         end
 
         # Get a list of all site logs. You can use the query params to filter your
@@ -740,6 +757,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::ExecutionList
             )
+
         end
 
         # Get a site request log by its unique ID.
@@ -774,6 +792,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Execution
             )
+
         end
 
         # Delete a site log by its unique ID.
@@ -808,14 +827,17 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Get a list of all variables of a specific site.
         #
         # @param [String] site_id Site unique 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, 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(site_id:)
+        def list_variables(site_id:, queries: nil, total: nil)
             api_path = '/sites/{siteId}/variables'
                 .gsub('{siteId}', site_id)
 
@@ -824,6 +846,8 @@ module Appwrite
             end
 
             api_params = {
+                queries: queries,
+                total: total,
             }
             
             api_headers = {
@@ -836,18 +860,20 @@ module Appwrite
                 params: api_params,
                 response_type: Models::VariableList
             )
+
         end
 
         # Create a new site variable. These variables can be accessed during build
         # and runtime (server-side rendering) as environment variables.
         #
         # @param [String] site_id Site unique ID.
+        # @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 sites can read them during build and runtime.
         #
         # @return [Variable]
-        def create_variable(site_id:, key:, value:, secret: nil)
+        def create_variable(site_id:, variable_id:, key:, value:, secret: nil)
             api_path = '/sites/{siteId}/variables'
                 .gsub('{siteId}', site_id)
 
@@ -855,6 +881,10 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "siteId"')
             end
 
+            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
@@ -864,6 +894,7 @@ module Appwrite
             end
 
             api_params = {
+                variableId: variable_id,
                 key: key,
                 value: value,
                 secret: secret,
@@ -880,6 +911,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Variable
             )
+
         end
 
         # Get a variable by its unique ID.
@@ -914,6 +946,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Variable
             )
+
         end
 
         # Update variable by its unique ID.
@@ -925,7 +958,7 @@ module Appwrite
         # @param [] secret Secret variables can be updated or deleted, but only sites can read them during build and runtime.
         #
         # @return [Variable]
-        def update_variable(site_id:, variable_id:, key:, value: nil, secret: nil)
+        def update_variable(site_id:, variable_id:, key: nil, value: nil, secret: nil)
             api_path = '/sites/{siteId}/variables/{variableId}'
                 .gsub('{siteId}', site_id)
                 .gsub('{variableId}', variable_id)
@@ -938,10 +971,6 @@ module Appwrite
               raise Appwrite::Exception.new('Missing required parameter: "variableId"')
             end
 
-            if key.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "key"')
-            end
-
             api_params = {
                 key: key,
                 value: value,
@@ -959,6 +988,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Variable
             )
+
         end
 
         # Delete a variable by its unique ID.
@@ -993,7 +1023,8 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
     end 
-end
+end

data/lib/appwrite/services/storage.rb

@@ -34,6 +34,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::BucketList
             )
+
         end
 
         # Create a new storage bucket.
@@ -87,6 +88,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Bucket
             )
+
         end
 
         # Get a storage bucket by its unique ID. This endpoint response returns a
@@ -116,6 +118,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Bucket
             )
+
         end
 
         # Update a storage bucket by its unique ID.
@@ -169,6 +172,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Bucket
             )
+
         end
 
         # Delete a storage bucket by its unique ID.
@@ -197,6 +201,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Get a list of all the user files. You can use the query params to filter
@@ -232,6 +237,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::FileList
             )
+
         end
 
         # Create a new file. Before using this route, you should create a new bucket
@@ -297,6 +303,7 @@ module Appwrite
                 on_progress: on_progress,
                 response_type: Models::File
             )
+
         end
 
         # Get a file by its unique ID. This endpoint response returns a JSON object
@@ -332,6 +339,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::File
             )
+
         end
 
         # Update a file by its unique ID. Only users with write permissions have
@@ -372,6 +380,7 @@ module Appwrite
                 params: api_params,
                 response_type: Models::File
             )
+
         end
 
         # Delete a file by its unique ID. Only users with write permissions have
@@ -407,6 +416,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Get a file content by its unique ID. The endpoint response return with a
@@ -444,6 +454,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Get a file preview image. Currently, this method supports preview for image
@@ -505,6 +516,7 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
         # Get a file content by its unique ID. This endpoint is similar to the
@@ -542,7 +554,8 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
+
         end
 
     end 
-end
+end