appwrite 26.0.0 → 27.0.0

data/lib/appwrite/services/organization.rb

@@ -89,6 +89,174 @@ module Appwrite
 
         end
 
+        # List app installations on the organization. Any organization member can
+        # read installations.
+        #
+        # @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.
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
+        #
+        # @return [AppInstallationList]
+        def list_installations(queries: nil, total: nil)
+            api_path = '/organization/installations'
+
+            api_params = {
+                queries: queries,
+                total: total,
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AppInstallationList
+            )
+
+        end
+
+        # Install an app on the organization. Only organization members with the
+        # owner role can install apps. The installation is granted the scopes the app
+        # currently requests.
+        #
+        # @param [String] app_id Application unique ID.
+        # @param [String] authorization_details Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.
+        #
+        # @return [AppInstallation]
+        def create_installation(app_id:, authorization_details: nil)
+            api_path = '/organization/installations'
+
+            if app_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "appId"')
+            end
+
+            api_params = {
+                appId: app_id,
+                authorizationDetails: authorization_details,
+            }
+            
+            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::AppInstallation
+            )
+
+        end
+
+        # Get an app installation on the organization by its unique ID. Any
+        # organization member can read installations.
+        #
+        # @param [String] installation_id Installation unique ID.
+        #
+        # @return [AppInstallation]
+        def get_installation(installation_id:)
+            api_path = '/organization/installations/{installationId}'
+                .gsub('{installationId}', installation_id)
+
+            if installation_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AppInstallation
+            )
+
+        end
+
+        # Update an app installation on the organization. Only organization members
+        # with the owner role can update installations. The installation's granted
+        # scopes are refreshed to the scopes the app currently requests; previously
+        # issued installation access tokens are revoked.
+        #
+        # @param [String] installation_id Installation unique ID.
+        # @param [String] authorization_details Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.
+        #
+        # @return [AppInstallation]
+        def update_installation(installation_id:, authorization_details: nil)
+            api_path = '/organization/installations/{installationId}'
+                .gsub('{installationId}', installation_id)
+
+            if installation_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+            end
+
+            api_params = {
+                authorizationDetails: authorization_details,
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AppInstallation
+            )
+
+        end
+
+        # Uninstall an app from the organization by its installation ID. Only
+        # organization members with the owner role can remove installations.
+        # Previously issued installation access tokens are revoked.
+        #
+        # @param [String] installation_id Installation unique ID.
+        #
+        # @return []
+        def delete_installation(installation_id:)
+            api_path = '/organization/installations/{installationId}'
+                .gsub('{installationId}', installation_id)
+
+            if installation_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+
+        end
+
         # Get a list of all API keys from the current organization.
         #
         # @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: expire, accessedAt, name, scopes

data/lib/appwrite/services/project.rb

@@ -123,56 +123,6 @@ module Appwrite
 
         end
 
-        # Create a new API key. It's recommended to have multiple API keys with
-        # strict scopes for separate functions within your project.
-        # 
-        # You can also create an ephemeral API key if you need a short-lived key
-        # instead.
-        #
-        # @param [String] key_id Key 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] name Key name. Max length: 128 chars.
-        # @param [Array] scopes Key scopes list. Maximum of 200 scopes are allowed.
-        # @param [String] expire Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
-        #
-        # @return [Key]
-        def create_key(key_id:, name:, scopes:, expire: nil)
-            api_path = '/project/keys'
-
-            if key_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "keyId"')
-            end
-
-            if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
-            end
-
-            if scopes.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "scopes"')
-            end
-
-            api_params = {
-                keyId: key_id,
-                name: name,
-                scopes: scopes,
-                expire: expire,
-            }
-            
-            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::Key
-            )
-
-        end
-
         # Create a new ephemeral API key. It's recommended to have multiple API keys
         # with strict scopes for separate functions within your project.
         # 
@@ -569,15 +519,17 @@ module Appwrite
         # @param [Integer] refresh_token_duration Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.
         # @param [Integer] public_access_token_duration Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.
         # @param [Integer] public_refresh_token_duration Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.
+        # @param [Integer] installation_access_token_duration Access token duration in seconds for app installation access tokens. Leave empty to use default 1 hour.
         # @param [] confidential_pkce When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
         # @param [String] verification_url URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.
         # @param [Integer] user_code_length Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.
         # @param [String] user_code_format Character set for device flow user codes: `numeric` (digits only — best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits — highest entropy per character). Defaults to `alphanumeric`.
         # @param [Integer] device_code_duration Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.
         # @param [Array] default_scopes List of OAuth2 scopes used when an authorization request omits the scope parameter. Every default scope must also be allowed by the OAuth2 server. Maximum of 100 scopes are allowed, each up to 128 characters long.
+        # @param [Array] installation_scopes List of scopes an application may request when installed on a team. Omitting the parameter clears the list, so no installation scopes can be granted. Maximum of 100 scopes are allowed, each up to 128 characters long.
         #
         # @return [Project]
-        def update_o_auth2_server(enabled:, authorization_url:, scopes: nil, authorization_details_types: nil, access_token_duration: nil, refresh_token_duration: nil, public_access_token_duration: nil, public_refresh_token_duration: nil, confidential_pkce: nil, verification_url: nil, user_code_length: nil, user_code_format: nil, device_code_duration: nil, default_scopes: nil)
+        def update_o_auth2_server(enabled:, authorization_url:, scopes: nil, authorization_details_types: nil, access_token_duration: nil, refresh_token_duration: nil, public_access_token_duration: nil, public_refresh_token_duration: nil, installation_access_token_duration: nil, confidential_pkce: nil, verification_url: nil, user_code_length: nil, user_code_format: nil, device_code_duration: nil, default_scopes: nil, installation_scopes: nil)
             api_path = '/project/oauth2-server'
 
             if enabled.nil?
@@ -597,12 +549,14 @@ module Appwrite
                 refreshTokenDuration: refresh_token_duration,
                 publicAccessTokenDuration: public_access_token_duration,
                 publicRefreshTokenDuration: public_refresh_token_duration,
+                installationAccessTokenDuration: installation_access_token_duration,
                 confidentialPkce: confidential_pkce,
                 verificationUrl: verification_url,
                 userCodeLength: user_code_length,
                 userCodeFormat: user_code_format,
                 deviceCodeDuration: device_code_duration,
                 defaultScopes: default_scopes,
+                installationScopes: installation_scopes,
             }
             
             api_headers = {
@@ -3049,6 +3003,44 @@ module Appwrite
 
         end
 
+        # Updating this policy allows you to control which factors users can use to
+        # complete an MFA challenge. Disabled factors cannot be used to create a
+        # challenge and are reported as unavailable when listing factors. The custom
+        # factor is disabled by default; enable it to deliver challenge codes through
+        # your own channel. Recovery codes always remain available as a fallback.
+        #
+        # @param [] totp Set to true to allow TOTP to complete an MFA challenge, or false to disable it.
+        # @param [] email Set to true to allow email to complete an MFA challenge, or false to disable it.
+        # @param [] phone Set to true to allow phone (SMS) to complete an MFA challenge, or false to disable it.
+        # @param [] custom Set to true to allow the custom factor to complete an MFA challenge, or false to disable it.
+        #
+        # @return [Project]
+        def update_mfa_factors_policy(totp: nil, email: nil, phone: nil, custom: nil)
+            api_path = '/project/policies/mfa-factors'
+
+            api_params = {
+                totp: totp,
+                email: email,
+                phone: phone,
+                custom: custom,
+            }
+            
+            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::Project
+            )
+
+        end
+
         # Updating this policy allows you to control if new passwords are checked
         # against most common passwords dictionary. When enabled, and user changes
         # their password, password must not be contained in the dictionary.
@@ -3093,7 +3085,7 @@ module Appwrite
         # users, and it will only start to collect and enforce the policy on password
         # changes since the policy is enabled.
         #
-        # @param [Integer] total Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.
+        # @param [Integer] total Set the password history length per user. Value can be between 1 and 20, or null to disable the limit.
         #
         # @return [Project]
         def update_password_history_policy(total:)
@@ -3233,7 +3225,7 @@ module Appwrite
         # Update maximum duration how long sessions created within a project should
         # stay active for.
         #
-        # @param [Integer] duration Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.
+        # @param [Integer] duration Maximum session length in seconds. Minium allowed value is 60 seconds, and maximum is 1 year, which is 31536000 seconds.
         #
         # @return [Project]
         def update_session_duration_policy(duration:)
@@ -3300,7 +3292,7 @@ module Appwrite
         # Update the maximum number of sessions allowed per user. When the limit is
         # hit, the oldest session will be deleted to make room for new one.
         #
-        # @param [Integer] total Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.
+        # @param [Integer] total Set the maximum number of sessions allowed per user. Value can be between 1 and 100.
         #
         # @return [Project]
         def update_session_limit_policy(total:)
@@ -3334,7 +3326,7 @@ module Appwrite
         # amount of existing users already exceeded the limit, all users remain
         # active, but new user sign up will be prohibited.
         #
-        # @param [Integer] total Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.
+        # @param [Integer] total Set the maximum number of users allowed in the project. Value can be between 0 and 10000. Use 0 or null to disable the limit.
         #
         # @return [Project]
         def update_user_limit_policy(total:)
@@ -3367,9 +3359,9 @@ module Appwrite
         # Get a policy by its unique ID. This endpoint returns the current
         # configuration for the requested project policy.
         #
-        # @param [ProjectPolicyId] policy_id Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
+        # @param [ProjectPolicyId] policy_id Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
         #
-        # @return [PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordStrength, PolicyPasswordPersonalData, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy, PolicyDenyAliasedEmail, PolicyDenyDisposableEmail, PolicyDenyFreeEmail, PolicyDenyCorporateEmail]
+        # @return [PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordStrength, PolicyPasswordPersonalData, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy, PolicyMfaFactors, PolicyDenyAliasedEmail, PolicyDenyDisposableEmail, PolicyDenyFreeEmail, PolicyDenyCorporateEmail]
         def get_policy(policy_id:)
             api_path = '/project/policies/{policyId}'
                 .gsub('{policyId}', policy_id)
@@ -3447,6 +3439,11 @@ module Appwrite
                 return Models::PolicyMembershipPrivacy.from(map: response)
             end
 
+            if response['$id'] == 'mfa-factors'
+
+                return Models::PolicyMfaFactors.from(map: response)
+            end
+
             if response['$id'] == 'deny-aliased-email'
 
                 return Models::PolicyDenyAliasedEmail.from(map: response)

data/lib/appwrite/services/proxy.rb

@@ -7,6 +7,50 @@ module Appwrite
             @client = client
         end
 
+        # Create a new CDN cache invalidation for a domain. Executes a hard purge of
+        # cached content.
+        # 
+        # Depending on type, the invalidation purges a single cache tag, a single URL
+        # path, or all cached content for the domain.
+        #
+        # @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.
+        #
+        # @return [ProxyInvalidation]
+        def create_invalidation(domain:, type:, reference: nil)
+            api_path = '/proxy/invalidations'
+
+            if domain.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "domain"')
+            end
+
+            if type.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "type"')
+            end
+
+            api_params = {
+                domain: domain,
+                type: type,
+                reference: reference,
+            }
+            
+            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::ProxyInvalidation
+            )
+
+        end
+
         # Get a list of all the proxy rules. You can use the query params to filter
         # your results.
         #

data/lib/appwrite/services/sites.rb

@@ -155,7 +155,7 @@ module Appwrite
 
         # List allowed site specifications for this instance.
         #
-        # @param [String] type Specification type to list. Can be one of: runtimes, builds.
+        # @param [String] type Specification type to list. Can be one of: runtimes, builds. Defaults to runtimes.
         #
         # @return [SpecificationList]
         def list_specifications(type: nil)
@@ -693,9 +693,10 @@ module Appwrite
         # @param [String] site_id Site ID.
         # @param [String] deployment_id Deployment ID.
         # @param [DeploymentDownloadType] type Deployment file to download. Can be: "source", "output".
+        # @param [String] token Presigned source-download token for accessing this deployment without a session (jobs-service).
         #
         # @return []
-        def get_deployment_download(site_id:, deployment_id:, type: nil)
+        def get_deployment_download(site_id:, deployment_id:, type: nil, token: nil)
             api_path = '/sites/{siteId}/deployments/{deploymentId}/download'
                 .gsub('{siteId}', site_id)
                 .gsub('{deploymentId}', deployment_id)
@@ -710,6 +711,7 @@ module Appwrite
 
             api_params = {
                 type: type,
+                token: token,
             }
             
             api_headers = {

data/lib/appwrite/services/storage.rb

@@ -217,7 +217,7 @@ module Appwrite
         # your results.
         #
         # @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
-        # @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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
+        # @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, folder, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
         # @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.
         #
@@ -274,9 +274,10 @@ module Appwrite
         # @param [String] file_id File 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 [file] file Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
         # @param [Array] permissions An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+        # @param [String] folder Virtual folder to place the file in, for example "photos/2026". Nest folders with `/`. Defaults to the bucket root.
         #
         # @return [File]
-        def create_file(bucket_id:, file_id:, file:, permissions: nil, on_progress: nil)
+        def create_file(bucket_id:, file_id:, file:, permissions: nil, folder: nil, on_progress: nil)
             api_path = '/storage/buckets/{bucketId}/files'
                 .gsub('{bucketId}', bucket_id)
 
@@ -296,6 +297,7 @@ module Appwrite
                 fileId: file_id,
                 file: file,
                 permissions: permissions,
+                folder: folder,
             }
             
             api_headers = {