appwrite 21.1.0 → 22.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7d65feccf5827c513e9c2975c3192a9c08538beb3369c13f4cc8687a524df35
-  data.tar.gz: 9067bd506e5b7ae9e4050c327a7c669c842b29a46b063a53a434f11923aa9bf3
+  metadata.gz: 4f4a3d1bf31ce4e73601bc346a1e2d1607cc7660dab949aa3d7cdac1c5072901
+  data.tar.gz: ce5739e6bdaa5f4a39c0d29153772395ad51dd53fcedea2114eff17f14fe2d67
 SHA512:
-  metadata.gz: 3bb093f2cf13c12960eae3682a0f9c7293a30217636f1ee9baa9b6d5a67739b18df5111a24b9bdfac7fcaa6e8ec1281e67e90e2c910f1a94a581673f42ff7322
-  data.tar.gz: a466eed8fc575662941dcaa7535514ea78111b026bd65bce6d1772a1766bee11963f4cf396b2330e7fb95a11d40549118e236790ab69086e37f28569cdd061e2
+  metadata.gz: 0db71f51932537771194fc8595e4093ab39c694c57e3fe8672c785d8160b1899f94d2b253be40b0e808708edb3c460a6ba023f21fee1c94d181836f2502d80f5
+  data.tar.gz: 22a815abefa4ed7cd85442cf03c01fa5cae995f3e53b91f05bf4f87982bd318f6f18b0b79b24194fd8569858c26bb0455decc79d01121164bd005df0b79cdf4f

data/lib/appwrite/client.rb

@@ -15,8 +15,8 @@ module Appwrite
                 'x-sdk-name'=> 'Ruby',
                 'x-sdk-platform'=> 'server',
                 'x-sdk-language'=> 'ruby',
-                'x-sdk-version'=> '21.1.0',
-                'X-Appwrite-Response-Format' => '1.8.0'
+                'x-sdk-version'=> '22.0.0',
+                'X-Appwrite-Response-Format' => '1.9.0'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'
         end
@@ -97,6 +97,45 @@ module Appwrite
             self
         end
 
+        # Set ImpersonateUserId
+        #
+        # Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+        #
+        # @param [String] value The value to set for the ImpersonateUserId header
+        #
+        # @return [self]
+        def set_impersonate_user_id(value)
+            add_header('x-appwrite-impersonate-user-id', value)
+
+            self
+        end
+
+        # Set ImpersonateUserEmail
+        #
+        # Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+        #
+        # @param [String] value The value to set for the ImpersonateUserEmail header
+        #
+        # @return [self]
+        def set_impersonate_user_email(value)
+            add_header('x-appwrite-impersonate-user-email', value)
+
+            self
+        end
+
+        # Set ImpersonateUserPhone
+        #
+        # Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+        #
+        # @param [String] value The value to set for the ImpersonateUserPhone header
+        #
+        # @return [self]
+        def set_impersonate_user_phone(value)
+            add_header('x-appwrite-impersonate-user-phone', value)
+
+            self
+        end
+
         # Set endpoint.
         #
         # @param [String] endpoint The endpoint to set

data/lib/appwrite/enums/backup_services.rb

@@ -2,6 +2,9 @@ module Appwrite
     module Enums
         module BackupServices
             DATABASES = 'databases'
+            TABLESDB = 'tablesdb'
+            DOCUMENTSDB = 'documentsdb'
+            VECTORSDB = 'vectorsdb'
             FUNCTIONS = 'functions'
             STORAGE = 'storage'
         end

data/lib/appwrite/enums/database_type.rb

@@ -3,6 +3,8 @@ module Appwrite
         module DatabaseType
             LEGACY = 'legacy'
             TABLESDB = 'tablesdb'
+            DOCUMENTSDB = 'documentsdb'
+            VECTORSDB = 'vectorsdb'
         end
     end
 end

data/lib/appwrite/enums/databases_index_type.rb

@@ -0,0 +1,10 @@
+module Appwrite
+    module Enums
+        module DatabasesIndexType
+            KEY = 'key'
+            FULLTEXT = 'fulltext'
+            UNIQUE = 'unique'
+            SPATIAL = 'spatial'
+        end
+    end
+end

data/lib/appwrite/enums/scopes.rb

@@ -58,6 +58,10 @@ module Appwrite
             ASSISTANT_READ = 'assistant.read'
             TOKENS_READ = 'tokens.read'
             TOKENS_WRITE = 'tokens.write'
+            WEBHOOKS_READ = 'webhooks.read'
+            WEBHOOKS_WRITE = 'webhooks.write'
+            PROJECT_READ = 'project.read'
+            PROJECT_WRITE = 'project.write'
             POLICIES_WRITE = 'policies.write'
             POLICIES_READ = 'policies.read'
             ARCHIVES_READ = 'archives.read'

data/lib/appwrite/enums/{index_type.rb → tables_db_index_type.rb}

@@ -1,6 +1,6 @@
 module Appwrite
     module Enums
-        module IndexType
+        module TablesDBIndexType
             KEY = 'key'
             FULLTEXT = 'fulltext'
             UNIQUE = 'unique'

data/lib/appwrite/enums/template_reference_type.rb

@@ -1,8 +1,8 @@
 module Appwrite
     module Enums
         module TemplateReferenceType
-            BRANCH = 'branch'
             COMMIT = 'commit'
+            BRANCH = 'branch'
             TAG = 'tag'
         end
     end

data/lib/appwrite/models/database.rb

@@ -64,6 +64,8 @@ module Appwrite
                 valid_type = [
                     Appwrite::Enums::DatabaseType::LEGACY,
                     Appwrite::Enums::DatabaseType::TABLESDB,
+                    Appwrite::Enums::DatabaseType::DOCUMENTSDB,
+                    Appwrite::Enums::DatabaseType::VECTORSDB,
                 ]
 
                 unless valid_type.include?(type)

data/lib/appwrite/models/function.rb

@@ -12,6 +12,7 @@ module Appwrite
             attr_reader :live
             attr_reader :logging
             attr_reader :runtime
+            attr_reader :deployment_retention
             attr_reader :deployment_id
             attr_reader :deployment_created_at
             attr_reader :latest_deployment_id
@@ -30,7 +31,8 @@ module Appwrite
             attr_reader :provider_branch
             attr_reader :provider_root_directory
             attr_reader :provider_silent_mode
-            attr_reader :specification
+            attr_reader :build_specification
+            attr_reader :runtime_specification
 
             def initialize(
                 id:,
@@ -42,6 +44,7 @@ module Appwrite
                 live:,
                 logging:,
                 runtime:,
+                deployment_retention:,
                 deployment_id:,
                 deployment_created_at:,
                 latest_deployment_id:,
@@ -60,7 +63,8 @@ module Appwrite
                 provider_branch:,
                 provider_root_directory:,
                 provider_silent_mode:,
-                specification:
+                build_specification:,
+                runtime_specification:
             )
                 @id = id
                 @created_at = created_at
@@ -71,6 +75,7 @@ module Appwrite
                 @live = live
                 @logging = logging
                 @runtime = runtime
+                @deployment_retention = deployment_retention
                 @deployment_id = deployment_id
                 @deployment_created_at = deployment_created_at
                 @latest_deployment_id = latest_deployment_id
@@ -89,7 +94,8 @@ module Appwrite
                 @provider_branch = provider_branch
                 @provider_root_directory = provider_root_directory
                 @provider_silent_mode = provider_silent_mode
-                @specification = specification
+                @build_specification = build_specification
+                @runtime_specification = runtime_specification
             end
 
             def self.from(map:)
@@ -103,6 +109,7 @@ module Appwrite
                     live: map["live"],
                     logging: map["logging"],
                     runtime: map["runtime"],
+                    deployment_retention: map["deploymentRetention"],
                     deployment_id: map["deploymentId"],
                     deployment_created_at: map["deploymentCreatedAt"],
                     latest_deployment_id: map["latestDeploymentId"],
@@ -121,7 +128,8 @@ module Appwrite
                     provider_branch: map["providerBranch"],
                     provider_root_directory: map["providerRootDirectory"],
                     provider_silent_mode: map["providerSilentMode"],
-                    specification: map["specification"]
+                    build_specification: map["buildSpecification"],
+                    runtime_specification: map["runtimeSpecification"]
                 )
             end
 
@@ -136,6 +144,7 @@ module Appwrite
                     "live": @live,
                     "logging": @logging,
                     "runtime": @runtime,
+                    "deploymentRetention": @deployment_retention,
                     "deploymentId": @deployment_id,
                     "deploymentCreatedAt": @deployment_created_at,
                     "latestDeploymentId": @latest_deployment_id,
@@ -154,7 +163,8 @@ module Appwrite
                     "providerBranch": @provider_branch,
                     "providerRootDirectory": @provider_root_directory,
                     "providerSilentMode": @provider_silent_mode,
-                    "specification": @specification
+                    "buildSpecification": @build_specification,
+                    "runtimeSpecification": @runtime_specification
                 }
             end
         end

data/lib/appwrite/models/site.rb

@@ -11,6 +11,7 @@ module Appwrite
             attr_reader :live
             attr_reader :logging
             attr_reader :framework
+            attr_reader :deployment_retention
             attr_reader :deployment_id
             attr_reader :deployment_created_at
             attr_reader :deployment_screenshot_light
@@ -22,13 +23,15 @@ module Appwrite
             attr_reader :timeout
             attr_reader :install_command
             attr_reader :build_command
+            attr_reader :start_command
             attr_reader :output_directory
             attr_reader :installation_id
             attr_reader :provider_repository_id
             attr_reader :provider_branch
             attr_reader :provider_root_directory
             attr_reader :provider_silent_mode
-            attr_reader :specification
+            attr_reader :build_specification
+            attr_reader :runtime_specification
             attr_reader :build_runtime
             attr_reader :adapter
             attr_reader :fallback_file
@@ -42,6 +45,7 @@ module Appwrite
                 live:,
                 logging:,
                 framework:,
+                deployment_retention:,
                 deployment_id:,
                 deployment_created_at:,
                 deployment_screenshot_light:,
@@ -53,13 +57,15 @@ module Appwrite
                 timeout:,
                 install_command:,
                 build_command:,
+                start_command:,
                 output_directory:,
                 installation_id:,
                 provider_repository_id:,
                 provider_branch:,
                 provider_root_directory:,
                 provider_silent_mode:,
-                specification:,
+                build_specification:,
+                runtime_specification:,
                 build_runtime:,
                 adapter:,
                 fallback_file:
@@ -72,6 +78,7 @@ module Appwrite
                 @live = live
                 @logging = logging
                 @framework = framework
+                @deployment_retention = deployment_retention
                 @deployment_id = deployment_id
                 @deployment_created_at = deployment_created_at
                 @deployment_screenshot_light = deployment_screenshot_light
@@ -83,13 +90,15 @@ module Appwrite
                 @timeout = timeout
                 @install_command = install_command
                 @build_command = build_command
+                @start_command = start_command
                 @output_directory = output_directory
                 @installation_id = installation_id
                 @provider_repository_id = provider_repository_id
                 @provider_branch = provider_branch
                 @provider_root_directory = provider_root_directory
                 @provider_silent_mode = provider_silent_mode
-                @specification = specification
+                @build_specification = build_specification
+                @runtime_specification = runtime_specification
                 @build_runtime = build_runtime
                 @adapter = adapter
                 @fallback_file = fallback_file
@@ -105,6 +114,7 @@ module Appwrite
                     live: map["live"],
                     logging: map["logging"],
                     framework: map["framework"],
+                    deployment_retention: map["deploymentRetention"],
                     deployment_id: map["deploymentId"],
                     deployment_created_at: map["deploymentCreatedAt"],
                     deployment_screenshot_light: map["deploymentScreenshotLight"],
@@ -116,13 +126,15 @@ module Appwrite
                     timeout: map["timeout"],
                     install_command: map["installCommand"],
                     build_command: map["buildCommand"],
+                    start_command: map["startCommand"],
                     output_directory: map["outputDirectory"],
                     installation_id: map["installationId"],
                     provider_repository_id: map["providerRepositoryId"],
                     provider_branch: map["providerBranch"],
                     provider_root_directory: map["providerRootDirectory"],
                     provider_silent_mode: map["providerSilentMode"],
-                    specification: map["specification"],
+                    build_specification: map["buildSpecification"],
+                    runtime_specification: map["runtimeSpecification"],
                     build_runtime: map["buildRuntime"],
                     adapter: map["adapter"],
                     fallback_file: map["fallbackFile"]
@@ -139,6 +151,7 @@ module Appwrite
                     "live": @live,
                     "logging": @logging,
                     "framework": @framework,
+                    "deploymentRetention": @deployment_retention,
                     "deploymentId": @deployment_id,
                     "deploymentCreatedAt": @deployment_created_at,
                     "deploymentScreenshotLight": @deployment_screenshot_light,
@@ -150,13 +163,15 @@ module Appwrite
                     "timeout": @timeout,
                     "installCommand": @install_command,
                     "buildCommand": @build_command,
+                    "startCommand": @start_command,
                     "outputDirectory": @output_directory,
                     "installationId": @installation_id,
                     "providerRepositoryId": @provider_repository_id,
                     "providerBranch": @provider_branch,
                     "providerRootDirectory": @provider_root_directory,
                     "providerSilentMode": @provider_silent_mode,
-                    "specification": @specification,
+                    "buildSpecification": @build_specification,
+                    "runtimeSpecification": @runtime_specification,
                     "buildRuntime": @build_runtime,
                     "adapter": @adapter,
                     "fallbackFile": @fallback_file

data/lib/appwrite/models/user.rb

@@ -22,6 +22,8 @@ module Appwrite
             attr_reader :prefs
             attr_reader :targets
             attr_reader :accessed_at
+            attr_reader :impersonator
+            attr_reader :impersonator_user_id
 
             def initialize(
                 id:,
@@ -42,7 +44,9 @@ module Appwrite
                 mfa:,
                 prefs:,
                 targets:,
-                accessed_at:
+                accessed_at:,
+                impersonator: ,
+                impersonator_user_id: 
             )
                 @id = id
                 @created_at = created_at
@@ -63,6 +67,8 @@ module Appwrite
                 @prefs = prefs
                 @targets = targets
                 @accessed_at = accessed_at
+                @impersonator = impersonator
+                @impersonator_user_id = impersonator_user_id
             end
 
             def self.from(map:)
@@ -85,7 +91,9 @@ module Appwrite
                     mfa: map["mfa"],
                     prefs: Preferences.from(map: map["prefs"]),
                     targets: map["targets"].map { |it| Target.from(map: it) },
-                    accessed_at: map["accessedAt"]
+                    accessed_at: map["accessedAt"],
+                    impersonator: map["impersonator"],
+                    impersonator_user_id: map["impersonatorUserId"]
                 )
             end
 
@@ -109,7 +117,9 @@ module Appwrite
                     "mfa": @mfa,
                     "prefs": @prefs.to_map,
                     "targets": @targets.map { |it| it.to_map },
-                    "accessedAt": @accessed_at
+                    "accessedAt": @accessed_at,
+                    "impersonator": @impersonator,
+                    "impersonatorUserId": @impersonator_user_id
                 }
             end
         end

data/lib/appwrite/models/webhook.rb

@@ -0,0 +1,87 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class Webhook
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :name
+            attr_reader :url
+            attr_reader :events
+            attr_reader :security
+            attr_reader :http_user
+            attr_reader :http_pass
+            attr_reader :signature_key
+            attr_reader :enabled
+            attr_reader :logs
+            attr_reader :attempts
+
+            def initialize(
+                id:,
+                created_at:,
+                updated_at:,
+                name:,
+                url:,
+                events:,
+                security:,
+                http_user:,
+                http_pass:,
+                signature_key:,
+                enabled:,
+                logs:,
+                attempts:
+            )
+                @id = id
+                @created_at = created_at
+                @updated_at = updated_at
+                @name = name
+                @url = url
+                @events = events
+                @security = security
+                @http_user = http_user
+                @http_pass = http_pass
+                @signature_key = signature_key
+                @enabled = enabled
+                @logs = logs
+                @attempts = attempts
+            end
+
+            def self.from(map:)
+                Webhook.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    name: map["name"],
+                    url: map["url"],
+                    events: map["events"],
+                    security: map["security"],
+                    http_user: map["httpUser"],
+                    http_pass: map["httpPass"],
+                    signature_key: map["signatureKey"],
+                    enabled: map["enabled"],
+                    logs: map["logs"],
+                    attempts: map["attempts"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
+                    "name": @name,
+                    "url": @url,
+                    "events": @events,
+                    "security": @security,
+                    "httpUser": @http_user,
+                    "httpPass": @http_pass,
+                    "signatureKey": @signature_key,
+                    "enabled": @enabled,
+                    "logs": @logs,
+                    "attempts": @attempts
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/webhook_list.rb

@@ -0,0 +1,32 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class WebhookList
+            attr_reader :total
+            attr_reader :webhooks
+
+            def initialize(
+                total:,
+                webhooks:
+            )
+                @total = total
+                @webhooks = webhooks
+            end
+
+            def self.from(map:)
+                WebhookList.new(
+                    total: map["total"],
+                    webhooks: map["webhooks"].map { |it| Webhook.from(map: it) }
+                )
+            end
+
+            def to_map
+                {
+                    "total": @total,
+                    "webhooks": @webhooks.map { |it| it.to_map }
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/services/databases.rb

@@ -3300,7 +3300,7 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
         # @param [String] key Index Key.
-        # @param [IndexType] type Index type.
+        # @param [DatabasesIndexType] type Index type.
         # @param [Array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
         # @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
         # @param [Array] lengths Length of index. Maximum of 100

data/lib/appwrite/services/functions.rb

@@ -58,10 +58,12 @@ module Appwrite
         # @param [String] provider_branch Production branch for the repo linked to the function.
         # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
         # @param [String] provider_root_directory Path to function code in the linked repo.
-        # @param [String] specification Runtime specification for the function and builds.
+        # @param [String] build_specification Build specification for the function deployments.
+        # @param [String] runtime_specification Runtime specification for the function executions.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
         #
         # @return [Function]
-        def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, specification: nil)
+        def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/functions'
 
             if function_id.nil?
@@ -94,7 +96,9 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
-                specification: specification,
+                buildSpecification: build_specification,
+                runtimeSpecification: runtime_specification,
+                deploymentRetention: deployment_retention,
             }
             
             api_headers = {
@@ -201,10 +205,12 @@ module Appwrite
         # @param [String] provider_branch Production branch for the repo linked to the function
         # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
         # @param [String] provider_root_directory Path to function code in the linked repo.
-        # @param [String] specification Runtime specification for the function and builds.
+        # @param [String] build_specification Build specification for the function deployments.
+        # @param [String] runtime_specification Runtime specification for the function executions.
+        # @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
         #
         # @return [Function]
-        def update(function_id:, name:, runtime: nil, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, specification: nil)
+        def update(function_id:, name:, runtime: nil, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/functions/{functionId}'
                 .gsub('{functionId}', function_id)
 
@@ -233,7 +239,9 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
-                specification: specification,
+                buildSpecification: build_specification,
+                runtimeSpecification: runtime_specification,
+                deploymentRetention: deployment_retention,
             }
             
             api_headers = {