appwrite 28.4.0 → 30.0.0

data/lib/appwrite/services/waf.rb

@@ -137,7 +137,7 @@ module Appwrite
             enabled: nil,
             conditions: nil
         )
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
@@ -284,7 +284,7 @@ module Appwrite
             difficulty: nil,
             ttl: nil
         )
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
@@ -415,7 +415,7 @@ module Appwrite
             enabled: nil,
             conditions: nil
         )
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
@@ -578,7 +578,7 @@ module Appwrite
             enabled: nil,
             conditions: nil
         )
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
@@ -728,7 +728,7 @@ module Appwrite
             enabled: nil,
             conditions: nil
         )
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
@@ -771,7 +771,7 @@ module Appwrite
         def get_rule(
             rule_id:
         )
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 
@@ -833,7 +833,7 @@ module Appwrite
         def delete_rule(
             rule_id:
         )
-            if rule_id.nil?
+            if rule_id.nil? || rule_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "ruleId"')
             end
 

data/lib/appwrite/services/webhooks.rb

@@ -47,9 +47,10 @@ module Appwrite
         # @param [Array] events Events list. Maximum of 100 events are allowed.
         # @param [] enabled Enable or disable a webhook.
         # @param [] tls Certificate verification, false for disabled or true for enabled.
-        # @param [String] auth_username Webhook HTTP user. Max length: 256 chars.
-        # @param [String] auth_password Webhook HTTP password. Max length: 256 chars.
+        # @param [String] auth_username Webhook HTTP user. Max length: 255 chars.
+        # @param [String] auth_password Webhook HTTP password. Max length: 2048 chars.
         # @param [String] secret Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
+        # @param [String] description Optional description for the webhook.
         #
         # @return [Webhook]
         def create(
@@ -61,10 +62,9 @@ module Appwrite
             tls: nil,
             auth_username: nil,
             auth_password: nil,
-            secret: nil
+            secret: nil,
+            description: nil
         )
-            api_path = '/webhooks'
-
             if webhook_id.nil?
                 raise Appwrite::Exception.new('Missing required parameter: "webhookId"')
             end
@@ -81,6 +81,8 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "events"')
             end
 
+            api_path = '/webhooks'
+
             api_params = {
                 webhookId: webhook_id,
                 url: url,
@@ -91,6 +93,7 @@ module Appwrite
                 authUsername: auth_username,
                 authPassword: auth_password,
                 secret: secret,
+                description: description,
             }
 
             api_headers = {
@@ -117,13 +120,13 @@ module Appwrite
         def get(
             webhook_id:
         )
-            api_path = '/webhooks/{webhookId}'
-                .gsub('{webhookId}', webhook_id)
-
-            if webhook_id.nil?
+            if webhook_id.nil? || webhook_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "webhookId"')
             end
 
+            api_path = '/webhooks/{webhookId}'
+                .gsub('{webhookId}', webhook_id)
+
             api_params = {}
 
             api_headers = {
@@ -149,8 +152,9 @@ module Appwrite
         # @param [Array] events Events list. Maximum of 100 events are allowed.
         # @param [] enabled Enable or disable a webhook.
         # @param [] tls Certificate verification, false for disabled or true for enabled.
-        # @param [String] auth_username Webhook HTTP user. Max length: 256 chars.
-        # @param [String] auth_password Webhook HTTP password. Max length: 256 chars.
+        # @param [String] auth_username Webhook HTTP user. Max length: 255 chars.
+        # @param [String] auth_password Webhook HTTP password. Max length: 2048 chars. Omit to keep the current password; it is cleared when the URL changes or TLS verification is disabled.
+        # @param [String] description Optional description for the webhook.
         #
         # @return [Webhook]
         def update(
@@ -161,12 +165,10 @@ module Appwrite
             enabled: nil,
             tls: nil,
             auth_username: nil,
-            auth_password: nil
+            auth_password: nil,
+            description: nil
         )
-            api_path = '/webhooks/{webhookId}'
-                .gsub('{webhookId}', webhook_id)
-
-            if webhook_id.nil?
+            if webhook_id.nil? || webhook_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "webhookId"')
             end
 
@@ -182,6 +184,9 @@ module Appwrite
                 raise Appwrite::Exception.new('Missing required parameter: "events"')
             end
 
+            api_path = '/webhooks/{webhookId}'
+                .gsub('{webhookId}', webhook_id)
+
             api_params = {
                 name: name,
                 url: url,
@@ -190,6 +195,7 @@ module Appwrite
                 tls: tls,
                 authUsername: auth_username,
                 authPassword: auth_password,
+                description: description,
             }
 
             api_headers = {
@@ -216,18 +222,19 @@ module Appwrite
         def delete(
             webhook_id:
         )
-            api_path = '/webhooks/{webhookId}'
-                .gsub('{webhookId}', webhook_id)
-
-            if webhook_id.nil?
+            if webhook_id.nil? || webhook_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "webhookId"')
             end
 
+            api_path = '/webhooks/{webhookId}'
+                .gsub('{webhookId}', webhook_id)
+
             api_params = {}
 
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
+                "accept": 'application/json',
             }
 
             @client.call(
@@ -250,13 +257,13 @@ module Appwrite
             webhook_id:,
             secret: nil
         )
-            api_path = '/webhooks/{webhookId}/secret'
-                .gsub('{webhookId}', webhook_id)
-
-            if webhook_id.nil?
+            if webhook_id.nil? || webhook_id == ''
                 raise Appwrite::Exception.new('Missing required parameter: "webhookId"')
             end
 
+            api_path = '/webhooks/{webhookId}/secret'
+                .gsub('{webhookId}', webhook_id)
+
             api_params = {
                 secret: secret,
             }

data/lib/appwrite/topic.rb

@@ -0,0 +1,53 @@
+module Appwrite
+    # Helper to build MQTT topics for `Push`, level by level.
+    #
+    #     Topic.path(['user', user_id, 'notification']) # "user/123/notification"
+    #     Topic.path(['org', org_id]).path(['logs']) # "org/42/logs"
+    class Topic
+        private_class_method :new
+
+        # Start a topic with the given levels, e.g. `Topic.path(['user', user_id])`.
+        def self.path(levels)
+            new([]).path(levels)
+        end
+
+        def initialize(levels)
+            @levels = levels.freeze
+        end
+
+        # Append the given levels.
+        def path(levels)
+            self.class.send(:new, @levels + self.class.send(:levels_of, levels))
+        end
+
+        def to_s
+            @levels.join('/')
+        end
+
+        # Validate the levels passed to `path`: a non-empty array of non-empty strings, none holding
+        # the level separator `/` or the MQTT wildcards `+` and `#`.
+        def self.levels_of(levels)
+            raise ArgumentError, "path() expects an array, e.g. path(['user'])" unless levels.is_a?(Array)
+            raise ArgumentError, 'path() needs at least one level' if levels.empty?
+
+            levels.each_with_index do |level, index|
+                unless level.is_a?(String)
+                    type = level.nil? ? 'null' : level.class.name
+                    raise ArgumentError, "level at index #{index} must be a string, got #{type}"
+                end
+                raise ArgumentError, "empty level at index #{index}" if level.empty?
+
+                if level.include?('/')
+                    parts = level.split('/', -1).map { |part| "'#{part}'" }.join(', ')
+                    raise ArgumentError, "\"#{level}\" contains \"/\", split it: path([#{parts}])"
+                end
+                raise ArgumentError, "\"#{level}\" contains \"+\", not allowed in a topic" if level.include?('+')
+                raise ArgumentError, "\"#{level}\" contains \"#\", not allowed in a topic" if level.include?('#')
+                raise ArgumentError, "level at index #{index} contains a NUL character" if level.include?("\0")
+            end
+
+            levels.dup
+        end
+        private_class_method :levels_of
+    end
+end

data/lib/appwrite.rb

@@ -11,6 +11,7 @@ require_relative 'appwrite/query'
 require_relative 'appwrite/permission'
 require_relative 'appwrite/role'
 require_relative 'appwrite/id'
+require_relative 'appwrite/topic'
 require_relative 'appwrite/operator'
 
 require_relative 'appwrite/models/row_list'
@@ -24,7 +25,6 @@ require_relative 'appwrite/models/column_index_list'
 require_relative 'appwrite/models/user_list'
 require_relative 'appwrite/models/session_list'
 require_relative 'appwrite/models/identity_list'
-require_relative 'appwrite/models/log_list'
 require_relative 'appwrite/models/file_list'
 require_relative 'appwrite/models/bucket_list'
 require_relative 'appwrite/models/resource_token_list'
@@ -111,7 +111,6 @@ require_relative 'appwrite/models/column_index'
 require_relative 'appwrite/models/row'
 require_relative 'appwrite/models/document'
 require_relative 'appwrite/models/presence'
-require_relative 'appwrite/models/log'
 require_relative 'appwrite/models/user'
 require_relative 'appwrite/models/algo_md5'
 require_relative 'appwrite/models/algo_sha'
@@ -147,7 +146,6 @@ require_relative 'appwrite/models/project_protocol'
 require_relative 'appwrite/models/webhook'
 require_relative 'appwrite/models/key'
 require_relative 'appwrite/models/ephemeral_key'
-require_relative 'appwrite/models/dev_key'
 require_relative 'appwrite/models/mock_number'
 require_relative 'appwrite/models/o_auth2_github'
 require_relative 'appwrite/models/o_auth2_discord'
@@ -211,6 +209,10 @@ require_relative 'appwrite/models/policy_user_limit'
 require_relative 'appwrite/models/policy_membership_privacy'
 require_relative 'appwrite/models/policy_mfa_factors'
 require_relative 'appwrite/models/policy_passkey'
+require_relative 'appwrite/models/policy_deny_aliased_email'
+require_relative 'appwrite/models/policy_deny_disposable_email'
+require_relative 'appwrite/models/policy_deny_free_email'
+require_relative 'appwrite/models/policy_deny_corporate_email'
 require_relative 'appwrite/models/platform_web'
 require_relative 'appwrite/models/platform_apple'
 require_relative 'appwrite/models/platform_android'
@@ -280,10 +282,6 @@ require_relative 'appwrite/models/proxy_invalidation'
 require_relative 'appwrite/models/organization'
 require_relative 'appwrite/models/dedicated_database_pitr_windows'
 require_relative 'appwrite/models/backup_policy'
-require_relative 'appwrite/models/policy_deny_aliased_email'
-require_relative 'appwrite/models/policy_deny_disposable_email'
-require_relative 'appwrite/models/policy_deny_free_email'
-require_relative 'appwrite/models/policy_deny_corporate_email'
 require_relative 'appwrite/models/dedicated_database_pooler'
 require_relative 'appwrite/models/postgres_extension'
 require_relative 'appwrite/models/program'
@@ -291,7 +289,6 @@ require_relative 'appwrite/models/backup_restoration'
 require_relative 'appwrite/models/dedicated_database_restoration_list'
 require_relative 'appwrite/models/dedicated_database_specification'
 require_relative 'appwrite/models/dedicated_database_specification_list'
-require_relative 'appwrite/models/dedicated_database_specification_pricing'
 require_relative 'appwrite/models/database_status_connections'
 require_relative 'appwrite/models/database_status_replica'
 require_relative 'appwrite/models/database_status_volume'
@@ -366,7 +363,6 @@ require_relative 'appwrite/enums/deployment_download_type'
 require_relative 'appwrite/enums/execution_method'
 require_relative 'appwrite/enums/message_priority'
 require_relative 'appwrite/enums/smtp_encryption'
-require_relative 'appwrite/enums/organization_key_scopes'
 require_relative 'appwrite/enums/region'
 require_relative 'appwrite/enums/project_auth_method_id'
 require_relative 'appwrite/enums/project_o_auth2_auth0_prompt'
@@ -420,6 +416,7 @@ require_relative 'appwrite/enums/o_auth2_kakao_prompt'
 require_relative 'appwrite/enums/platform_type'
 require_relative 'appwrite/enums/proxy_rule_deployment_resource_type'
 require_relative 'appwrite/enums/proxy_rule_status'
+require_relative 'appwrite/enums/proxy_rule_protocol'
 require_relative 'appwrite/enums/message_status'
 require_relative 'appwrite/enums/billing_plan_group'
 require_relative 'appwrite/enums/domain_transfer_status_enum'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appwrite
 version: !ruby/object:Gem::Version
-  version: 28.4.0
+  version: 30.0.0
 platform: ruby
 authors:
 - Appwrite Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-14 00:00:00.000000000 Z
+date: 2026-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -80,7 +80,6 @@ files:
 - lib/appwrite/enums/o_auth2_zoho_prompt.rb
 - lib/appwrite/enums/o_auth_provider.rb
 - lib/appwrite/enums/order_by.rb
-- lib/appwrite/enums/organization_key_scopes.rb
 - lib/appwrite/enums/password_hash.rb
 - lib/appwrite/enums/platform_type.rb
 - lib/appwrite/enums/project_auth_method_id.rb
@@ -104,6 +103,7 @@ files:
 - lib/appwrite/enums/project_smtp_secure.rb
 - lib/appwrite/enums/proxy_resource_type.rb
 - lib/appwrite/enums/proxy_rule_deployment_resource_type.rb
+- lib/appwrite/enums/proxy_rule_protocol.rb
 - lib/appwrite/enums/proxy_rule_status.rb
 - lib/appwrite/enums/region.rb
 - lib/appwrite/enums/relation_mutate.rb
@@ -236,10 +236,8 @@ files:
 - lib/appwrite/models/dedicated_database_restoration_list.rb
 - lib/appwrite/models/dedicated_database_specification.rb
 - lib/appwrite/models/dedicated_database_specification_list.rb
-- lib/appwrite/models/dedicated_database_specification_pricing.rb
 - lib/appwrite/models/deployment.rb
 - lib/appwrite/models/deployment_list.rb
-- lib/appwrite/models/dev_key.rb
 - lib/appwrite/models/dns_record.rb
 - lib/appwrite/models/dns_records_list.rb
 - lib/appwrite/models/document.rb
@@ -279,8 +277,6 @@ files:
 - lib/appwrite/models/locale.rb
 - lib/appwrite/models/locale_code.rb
 - lib/appwrite/models/locale_code_list.rb
-- lib/appwrite/models/log.rb
-- lib/appwrite/models/log_list.rb
 - lib/appwrite/models/membership.rb
 - lib/appwrite/models/membership_list.rb
 - lib/appwrite/models/message.rb
@@ -448,6 +444,7 @@ files:
 - lib/appwrite/operator.rb
 - lib/appwrite/permission.rb
 - lib/appwrite/query.rb
+- lib/appwrite/query/builder.rb
 - lib/appwrite/role.rb
 - lib/appwrite/service.rb
 - lib/appwrite/services/account.rb
@@ -481,6 +478,7 @@ files:
 - lib/appwrite/services/vectors_db.rb
 - lib/appwrite/services/waf.rb
 - lib/appwrite/services/webhooks.rb
+- lib/appwrite/topic.rb
 homepage: https://appwrite.io/support
 licenses:
 - BSD-3-Clause
@@ -493,7 +491,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/appwrite/enums/organization_key_scopes.rb

@@ -1,22 +0,0 @@
-module Appwrite
-    module Enums
-        module OrganizationKeyScopes
-            PROJECTS_READ = 'projects.read'
-            PROJECTS_WRITE = 'projects.write'
-            DEVKEYS_READ = 'devKeys.read'
-            DEVKEYS_WRITE = 'devKeys.write'
-            ORGANIZATION_KEYS_READ = 'organization.keys.read'
-            ORGANIZATION_KEYS_WRITE = 'organization.keys.write'
-            ORGANIZATION_INSTALLATIONS_READ = 'organization.installations.read'
-            ORGANIZATION_INSTALLATIONS_WRITE = 'organization.installations.write'
-            ORGANIZATION_MEMBERSHIPS_READ = 'organization.memberships.read'
-            ORGANIZATION_MEMBERSHIPS_WRITE = 'organization.memberships.write'
-            ORGANIZATION_READ = 'organization.read'
-            ORGANIZATION_WRITE = 'organization.write'
-            DOMAINS_READ = 'domains.read'
-            DOMAINS_WRITE = 'domains.write'
-            KEYS_READ = 'keys.read'
-            KEYS_WRITE = 'keys.write'
-        end
-    end
-end

data/lib/appwrite/models/dedicated_database_specification_pricing.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Appwrite
-    module Models
-        class DedicatedDatabaseSpecificationPricing
-            attr_reader :storage_overage_rate
-            attr_reader :bandwidth_overage_rate
-            attr_reader :replica_rate
-            attr_reader :pitr_rate
-
-            def initialize(
-                storage_overage_rate:,
-                bandwidth_overage_rate:,
-                replica_rate:,
-                pitr_rate:
-            )
-                @storage_overage_rate = storage_overage_rate
-                @bandwidth_overage_rate = bandwidth_overage_rate
-                @replica_rate = replica_rate
-                @pitr_rate = pitr_rate
-            end
-
-            def self.from(map:)
-                DedicatedDatabaseSpecificationPricing.new(
-                    storage_overage_rate: map["storageOverageRate"],
-                    bandwidth_overage_rate: map["bandwidthOverageRate"],
-                    replica_rate: map["replicaRate"],
-                    pitr_rate: map["pitrRate"]
-                )
-            end
-
-            def to_map
-                {
-                    "storageOverageRate": @storage_overage_rate,
-                    "bandwidthOverageRate": @bandwidth_overage_rate,
-                    "replicaRate": @replica_rate,
-                    "pitrRate": @pitr_rate
-                }
-            end
-        end
-    end
-end

data/lib/appwrite/models/dev_key.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Appwrite
-    module Models
-        class DevKey
-            attr_reader :id
-            attr_reader :created_at
-            attr_reader :updated_at
-            attr_reader :name
-            attr_reader :expire
-            attr_reader :secret
-            attr_reader :accessed_at
-            attr_reader :sdks
-
-            def initialize(
-                id:,
-                created_at:,
-                updated_at:,
-                name:,
-                expire:,
-                secret:,
-                accessed_at:,
-                sdks:
-            )
-                @id = id
-                @created_at = created_at
-                @updated_at = updated_at
-                @name = name
-                @expire = expire
-                @secret = secret
-                @accessed_at = accessed_at
-                @sdks = sdks
-            end
-
-            def self.from(map:)
-                DevKey.new(
-                    id: map["$id"],
-                    created_at: map["$createdAt"],
-                    updated_at: map["$updatedAt"],
-                    name: map["name"],
-                    expire: map["expire"],
-                    secret: map["secret"],
-                    accessed_at: map["accessedAt"],
-                    sdks: map["sdks"]
-                )
-            end
-
-            def to_map
-                {
-                    "$id": @id,
-                    "$createdAt": @created_at,
-                    "$updatedAt": @updated_at,
-                    "name": @name,
-                    "expire": @expire,
-                    "secret": @secret,
-                    "accessedAt": @accessed_at,
-                    "sdks": @sdks
-                }
-            end
-        end
-    end
-end

data/lib/appwrite/models/log.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Appwrite
-    module Models
-        class Log
-            attr_reader :event
-            attr_reader :user_id
-            attr_reader :user_email
-            attr_reader :user_name
-            attr_reader :mode
-            attr_reader :user_type
-            attr_reader :ip
-            attr_reader :time
-            attr_reader :os_code
-            attr_reader :os_name
-            attr_reader :os_version
-            attr_reader :client_type
-            attr_reader :client_code
-            attr_reader :client_name
-            attr_reader :client_version
-            attr_reader :client_engine
-            attr_reader :client_engine_version
-            attr_reader :device_name
-            attr_reader :device_brand
-            attr_reader :device_model
-            attr_reader :country_code
-            attr_reader :country_name
-
-            def initialize(
-                event:,
-                user_id:,
-                user_email:,
-                user_name:,
-                mode:,
-                user_type:,
-                ip:,
-                time:,
-                os_code:,
-                os_name:,
-                os_version:,
-                client_type:,
-                client_code:,
-                client_name:,
-                client_version:,
-                client_engine:,
-                client_engine_version:,
-                device_name:,
-                device_brand:,
-                device_model:,
-                country_code:,
-                country_name:
-            )
-                @event = event
-                @user_id = user_id
-                @user_email = user_email
-                @user_name = user_name
-                @mode = mode
-                @user_type = user_type
-                @ip = ip
-                @time = time
-                @os_code = os_code
-                @os_name = os_name
-                @os_version = os_version
-                @client_type = client_type
-                @client_code = client_code
-                @client_name = client_name
-                @client_version = client_version
-                @client_engine = client_engine
-                @client_engine_version = client_engine_version
-                @device_name = device_name
-                @device_brand = device_brand
-                @device_model = device_model
-                @country_code = country_code
-                @country_name = country_name
-            end
-
-            def self.from(map:)
-                Log.new(
-                    event: map["event"],
-                    user_id: map["userId"],
-                    user_email: map["userEmail"],
-                    user_name: map["userName"],
-                    mode: map["mode"],
-                    user_type: map["userType"],
-                    ip: map["ip"],
-                    time: map["time"],
-                    os_code: map["osCode"],
-                    os_name: map["osName"],
-                    os_version: map["osVersion"],
-                    client_type: map["clientType"],
-                    client_code: map["clientCode"],
-                    client_name: map["clientName"],
-                    client_version: map["clientVersion"],
-                    client_engine: map["clientEngine"],
-                    client_engine_version: map["clientEngineVersion"],
-                    device_name: map["deviceName"],
-                    device_brand: map["deviceBrand"],
-                    device_model: map["deviceModel"],
-                    country_code: map["countryCode"],
-                    country_name: map["countryName"]
-                )
-            end
-
-            def to_map
-                {
-                    "event": @event,
-                    "userId": @user_id,
-                    "userEmail": @user_email,
-                    "userName": @user_name,
-                    "mode": @mode,
-                    "userType": @user_type,
-                    "ip": @ip,
-                    "time": @time,
-                    "osCode": @os_code,
-                    "osName": @os_name,
-                    "osVersion": @os_version,
-                    "clientType": @client_type,
-                    "clientCode": @client_code,
-                    "clientName": @client_name,
-                    "clientVersion": @client_version,
-                    "clientEngine": @client_engine,
-                    "clientEngineVersion": @client_engine_version,
-                    "deviceName": @device_name,
-                    "deviceBrand": @device_brand,
-                    "deviceModel": @device_model,
-                    "countryCode": @country_code,
-                    "countryName": @country_name
-                }
-            end
-        end
-    end
-end