appwrite 26.1.0 → 27.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02891ab1059978945c4a148b229e240f171612f8cfe7ed5d677ddc965796439e'
-  data.tar.gz: 390bb97d112b72b6baeb7a2d9d1d38f155bedb6136b2d326e8d62ce3fad44476
+  metadata.gz: 3a73d97b624d3ac66916b15ad5c0aa8e66cfa1005586c80c6f9aa83d9034bec8
+  data.tar.gz: 825b9ded02f01fe66c2b6345ab57e8770829983bfd73d44344c38d5c91d8371d
 SHA512:
-  metadata.gz: 75ccab76ec05a49ead852f078afe07efbbee3b73b09820737597298e5a0b403d3f5deca9572dd41f0c4a0fd09cae1f98b3ed76ae0025370213b915d3d9aa7b2f
-  data.tar.gz: baf6dd1c0e4522e91a5079404619e1df15d221904ef1c7646ede6a3068bbe085167e285cfc6fd27f1cb3f5f3ec2fe7b85f9cb68f4893b8cd46bcd54a186e5d74
+  metadata.gz: a9945c6b86ffb93305150808a22794844086d95d06b21f199821491c4bdecc8d5d9e2d7940c6575c7c74ee4e07c0c70d9592dd8f1f37b1666e41890c080a36ac
+  data.tar.gz: 5cbfd6721c12062921f5ead66aec71fce1655041321afd829b8907fb4db37abf36edfa5b3b7388c508647608955f1fc55f3f57c6d38fdd130414a2f7b0d79fe8

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'=> '26.1.0',
-                'X-Appwrite-Response-Format' => '1.9.5'
+                'x-sdk-version'=> '27.0.0',
+                'X-Appwrite-Response-Format' => '1.9.6'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'
             @config = {}
@@ -49,6 +49,20 @@ module Appwrite
             self
         end
 
+        # Set Organization
+        #
+        # Your organization ID
+        #
+        # @param [String] value The value to set for the Organization header
+        #
+        # @return [self]
+        def set_organization(value)
+            add_header('x-appwrite-organization', value)
+            @config['organization'] = value
+
+            self
+        end
+
         # Set JWT
         #
         # Your secret JSON Web Token

data/lib/appwrite/enums/authentication_factor.rb

@@ -5,6 +5,7 @@ module Appwrite
             PHONE = 'phone'
             TOTP = 'totp'
             RECOVERYCODE = 'recoverycode'
+            CUSTOM = 'custom'
         end
     end
 end

data/lib/appwrite/enums/build_runtime.rb

@@ -11,6 +11,7 @@ module Appwrite
             NODE_23 = 'node-23'
             NODE_24 = 'node-24'
             NODE_25 = 'node-25'
+            NODE_26 = 'node-26'
             PHP_8_0 = 'php-8.0'
             PHP_8_1 = 'php-8.1'
             PHP_8_2 = 'php-8.2'

data/lib/appwrite/enums/embedding_model.rb

@@ -0,0 +1,10 @@
+module Appwrite
+    module Enums
+        module EmbeddingModel
+            NOMIC_EMBED_TEXT = 'nomic-embed-text'
+            EMBEDDING_GEMMA = 'embedding-gemma'
+            ALL_MINILM = 'all-minilm'
+            BGE_SMALL = 'bge-small'
+        end
+    end
+end

data/lib/appwrite/enums/invalidation_type.rb

@@ -0,0 +1,9 @@
+module Appwrite
+    module Enums
+        module InvalidationType
+            TAG = 'tag'
+            PATH = 'path'
+            ALL = 'all'
+        end
+    end
+end

data/lib/appwrite/enums/project_key_scopes.rb

@@ -35,6 +35,7 @@ module Appwrite
             INDEXES_WRITE = 'indexes.write'
             ROWS_READ = 'rows.read'
             ROWS_WRITE = 'rows.write'
+            EMBEDDINGS_WRITE = 'embeddings.write'
             COLLECTIONS_READ = 'collections.read'
             COLLECTIONS_WRITE = 'collections.write'
             ATTRIBUTES_READ = 'attributes.read'
@@ -99,6 +100,7 @@ module Appwrite
             WAFRULES_READ = 'wafRules.read'
             WAFRULES_WRITE = 'wafRules.write'
             EVENTS_READ = 'events.read'
+            PROXY_INVALIDATIONS_WRITE = 'proxy.invalidations.write'
             APPS_READ = 'apps.read'
             APPS_WRITE = 'apps.write'
             OAUTH2_READ = 'oauth2.read'

data/lib/appwrite/enums/project_policy_id.rb

@@ -11,6 +11,7 @@ module Appwrite
             SESSION_LIMIT = 'session-limit'
             USER_LIMIT = 'user-limit'
             MEMBERSHIP_PRIVACY = 'membership-privacy'
+            MFA_FACTORS = 'mfa-factors'
             DENY_ALIASED_EMAIL = 'deny-aliased-email'
             DENY_DISPOSABLE_EMAIL = 'deny-disposable-email'
             DENY_FREE_EMAIL = 'deny-free-email'

data/lib/appwrite/enums/runtime.rb

@@ -11,6 +11,7 @@ module Appwrite
             NODE_23 = 'node-23'
             NODE_24 = 'node-24'
             NODE_25 = 'node-25'
+            NODE_26 = 'node-26'
             PHP_8_0 = 'php-8.0'
             PHP_8_1 = 'php-8.1'
             PHP_8_2 = 'php-8.2'

data/lib/appwrite/models/billing_plan.rb

@@ -84,7 +84,7 @@ module Appwrite
                 storage:,
                 image_transformations:,
                 screenshots_generated:,
-                members:,
+                members: ,
                 webhooks:,
                 waf_rules:,
                 projects:,
@@ -108,7 +108,7 @@ module Appwrite
                 topics:,
                 auth_phone:,
                 domains:,
-                activity_logs:,
+                activity_logs: ,
                 usage_logs:,
                 usage_logs_intervals: ,
                 project_inactivity_days:,
@@ -132,10 +132,10 @@ module Appwrite
                 supports_free_email_validation:,
                 supports_corporate_email_validation:,
                 supports_project_specific_roles:,
-                backups_enabled:,
+                backups_enabled: ,
                 usage_per_project:,
                 supported_addons:,
-                backup_policies:,
+                backup_policies: ,
                 deployment_size:,
                 build_size:,
                 databases_allow_encrypt:,

data/lib/appwrite/models/billing_plan_addon.rb

@@ -7,8 +7,8 @@ module Appwrite
             attr_reader :projects
 
             def initialize(
-                seats:,
-                projects:
+                seats: ,
+                projects: 
             )
                 @seats = seats
                 @projects = projects
@@ -16,15 +16,15 @@ module Appwrite
 
             def self.from(map:)
                 BillingPlanAddon.new(
-                    seats: BillingPlanAddonDetails.from(map: map["seats"]),
-                    projects: BillingPlanAddonDetails.from(map: map["projects"])
+                    seats: map["seats"].nil? ? nil : BillingPlanAddonDetails.from(map: map["seats"]),
+                    projects: map["projects"].nil? ? nil : BillingPlanAddonDetails.from(map: map["projects"])
                 )
             end
 
             def to_map
                 {
-                    "seats": @seats.to_map,
-                    "projects": @projects.to_map
+                    "seats": @seats&.to_map,
+                    "projects": @projects&.to_map
                 }
             end
         end

data/lib/appwrite/models/billing_plan_addon_details.rb

@@ -17,7 +17,7 @@ module Appwrite
                 plan_included:,
                 limit:,
                 type:,
-                currency:,
+                currency: ,
                 price:,
                 value:,
                 invoice_desc:

data/lib/appwrite/models/database_migration.rb

@@ -0,0 +1,102 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class DatabaseMigration
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :project_id
+            attr_reader :database_id
+            attr_reader :specification
+            attr_reader :phase
+            attr_reader :attempt
+            attr_reader :last_error
+            attr_reader :lag_documents
+            attr_reader :verified_at
+            attr_reader :cutover_at
+            attr_reader :soak_until
+            attr_reader :auto_cutover
+            attr_reader :cutover_requested
+            attr_reader :paused
+
+            def initialize(
+                id:,
+                created_at:,
+                updated_at:,
+                project_id:,
+                database_id:,
+                specification:,
+                phase:,
+                attempt:,
+                last_error:,
+                lag_documents:,
+                verified_at:,
+                cutover_at:,
+                soak_until:,
+                auto_cutover:,
+                cutover_requested:,
+                paused:
+            )
+                @id = id
+                @created_at = created_at
+                @updated_at = updated_at
+                @project_id = project_id
+                @database_id = database_id
+                @specification = specification
+                @phase = phase
+                @attempt = attempt
+                @last_error = last_error
+                @lag_documents = lag_documents
+                @verified_at = verified_at
+                @cutover_at = cutover_at
+                @soak_until = soak_until
+                @auto_cutover = auto_cutover
+                @cutover_requested = cutover_requested
+                @paused = paused
+            end
+
+            def self.from(map:)
+                DatabaseMigration.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    project_id: map["projectId"],
+                    database_id: map["databaseId"],
+                    specification: map["specification"],
+                    phase: map["phase"],
+                    attempt: map["attempt"],
+                    last_error: map["lastError"],
+                    lag_documents: map["lagDocuments"],
+                    verified_at: map["verifiedAt"],
+                    cutover_at: map["cutoverAt"],
+                    soak_until: map["soakUntil"],
+                    auto_cutover: map["autoCutover"],
+                    cutover_requested: map["cutoverRequested"],
+                    paused: map["paused"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
+                    "projectId": @project_id,
+                    "databaseId": @database_id,
+                    "specification": @specification,
+                    "phase": @phase,
+                    "attempt": @attempt,
+                    "lastError": @last_error,
+                    "lagDocuments": @lag_documents,
+                    "verifiedAt": @verified_at,
+                    "cutoverAt": @cutover_at,
+                    "soakUntil": @soak_until,
+                    "autoCutover": @auto_cutover,
+                    "cutoverRequested": @cutover_requested,
+                    "paused": @paused
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/database_migration_list.rb

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

data/lib/appwrite/models/database_status.rb

@@ -9,6 +9,12 @@ module Appwrite
             attr_reader :version
             attr_reader :uptime
             attr_reader :connections
+            attr_reader :sync_mode
+            attr_reader :effective_sync_mode
+            attr_reader :sync_degraded
+            attr_reader :sync_acknowledgements
+            attr_reader :sync_standby_count
+            attr_reader :sync_state_confirmed
             attr_reader :replicas
             attr_reader :volumes
 
@@ -19,6 +25,12 @@ module Appwrite
                 version:,
                 uptime:,
                 connections:,
+                sync_mode:,
+                effective_sync_mode: ,
+                sync_degraded:,
+                sync_acknowledgements:,
+                sync_standby_count:,
+                sync_state_confirmed: ,
                 replicas:,
                 volumes:
             )
@@ -28,6 +40,12 @@ module Appwrite
                 @version = version
                 @uptime = uptime
                 @connections = connections
+                @sync_mode = sync_mode
+                @effective_sync_mode = effective_sync_mode
+                @sync_degraded = sync_degraded
+                @sync_acknowledgements = sync_acknowledgements
+                @sync_standby_count = sync_standby_count
+                @sync_state_confirmed = sync_state_confirmed
                 @replicas = replicas
                 @volumes = volumes
             end
@@ -40,6 +58,12 @@ module Appwrite
                     version: map["version"],
                     uptime: map["uptime"],
                     connections: DatabaseStatusConnections.from(map: map["connections"]),
+                    sync_mode: map["syncMode"],
+                    effective_sync_mode: map["effectiveSyncMode"],
+                    sync_degraded: map["syncDegraded"],
+                    sync_acknowledgements: map["syncAcknowledgements"],
+                    sync_standby_count: map["syncStandbyCount"],
+                    sync_state_confirmed: map["syncStateConfirmed"],
                     replicas: map["replicas"].map { |it| DatabaseStatusReplica.from(map: it) },
                     volumes: map["volumes"].map { |it| DatabaseStatusVolume.from(map: it) }
                 )
@@ -53,6 +77,12 @@ module Appwrite
                     "version": @version,
                     "uptime": @uptime,
                     "connections": @connections.to_map,
+                    "syncMode": @sync_mode,
+                    "effectiveSyncMode": @effective_sync_mode,
+                    "syncDegraded": @sync_degraded,
+                    "syncAcknowledgements": @sync_acknowledgements,
+                    "syncStandbyCount": @sync_standby_count,
+                    "syncStateConfirmed": @sync_state_confirmed,
                     "replicas": @replicas.map { |it| it.to_map },
                     "volumes": @volumes.map { |it| it.to_map }
                 }

data/lib/appwrite/models/dedicated_database.rb

@@ -33,7 +33,6 @@ module Appwrite
             attr_reader :node_pool
             attr_reader :replicas
             attr_reader :sync_mode
-            attr_reader :cross_region_replicas
             attr_reader :network_max_connections
             attr_reader :network_idle_timeout_seconds
             attr_reader :network_ip_allowlist
@@ -84,7 +83,6 @@ module Appwrite
                 node_pool:,
                 replicas:,
                 sync_mode:,
-                cross_region_replicas:,
                 network_max_connections:,
                 network_idle_timeout_seconds:,
                 network_ip_allowlist:,
@@ -134,7 +132,6 @@ module Appwrite
                 @node_pool = node_pool
                 @replicas = replicas
                 @sync_mode = sync_mode
-                @cross_region_replicas = cross_region_replicas
                 @network_max_connections = network_max_connections
                 @network_idle_timeout_seconds = network_idle_timeout_seconds
                 @network_ip_allowlist = network_ip_allowlist
@@ -187,7 +184,6 @@ module Appwrite
                     node_pool: map["nodePool"],
                     replicas: map["replicas"],
                     sync_mode: map["syncMode"],
-                    cross_region_replicas: map["crossRegionReplicas"],
                     network_max_connections: map["networkMaxConnections"],
                     network_idle_timeout_seconds: map["networkIdleTimeoutSeconds"],
                     network_ip_allowlist: map["networkIPAllowlist"],
@@ -241,7 +237,6 @@ module Appwrite
                     "nodePool": @node_pool,
                     "replicas": @replicas,
                     "syncMode": @sync_mode,
-                    "crossRegionReplicas": @cross_region_replicas,
                     "networkMaxConnections": @network_max_connections,
                     "networkIdleTimeoutSeconds": @network_idle_timeout_seconds,
                     "networkIPAllowlist": @network_ip_allowlist,

data/lib/appwrite/models/dedicated_database_member.rb

@@ -12,7 +12,7 @@ module Appwrite
                 id:,
                 role:,
                 status:,
-                lag_seconds:
+                lag_seconds: 
             )
                 @id = id
                 @role = role

data/lib/appwrite/models/dedicated_database_operation.rb

@@ -0,0 +1,77 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class DedicatedDatabaseOperation
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :database_id
+            attr_reader :type
+            attr_reader :status
+            attr_reader :attempts
+            attr_reader :requested_at
+            attr_reader :started_at
+            attr_reader :completed_at
+            attr_reader :error_code
+            attr_reader :error_message
+
+            def initialize(
+                id:,
+                created_at:,
+                database_id:,
+                type:,
+                status:,
+                attempts:,
+                requested_at: ,
+                started_at: ,
+                completed_at: ,
+                error_code:,
+                error_message:
+            )
+                @id = id
+                @created_at = created_at
+                @database_id = database_id
+                @type = type
+                @status = status
+                @attempts = attempts
+                @requested_at = requested_at
+                @started_at = started_at
+                @completed_at = completed_at
+                @error_code = error_code
+                @error_message = error_message
+            end
+
+            def self.from(map:)
+                DedicatedDatabaseOperation.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    database_id: map["databaseId"],
+                    type: map["type"],
+                    status: map["status"],
+                    attempts: map["attempts"],
+                    requested_at: map["requestedAt"],
+                    started_at: map["startedAt"],
+                    completed_at: map["completedAt"],
+                    error_code: map["errorCode"],
+                    error_message: map["errorMessage"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "databaseId": @database_id,
+                    "type": @type,
+                    "status": @status,
+                    "attempts": @attempts,
+                    "requestedAt": @requested_at,
+                    "startedAt": @started_at,
+                    "completedAt": @completed_at,
+                    "errorCode": @error_code,
+                    "errorMessage": @error_message
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/dedicated_database_operation_list.rb

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

data/lib/appwrite/models/dedicated_database_replicas.rb

@@ -5,15 +5,30 @@ module Appwrite
         class DedicatedDatabaseReplicas
             attr_reader :replicas
             attr_reader :sync_mode
+            attr_reader :effective_sync_mode
+            attr_reader :sync_degraded
+            attr_reader :sync_acknowledgements
+            attr_reader :sync_standby_count
+            attr_reader :sync_state_confirmed
             attr_reader :members
 
             def initialize(
                 replicas:,
                 sync_mode:,
+                effective_sync_mode: ,
+                sync_degraded:,
+                sync_acknowledgements:,
+                sync_standby_count:,
+                sync_state_confirmed: ,
                 members:
             )
                 @replicas = replicas
                 @sync_mode = sync_mode
+                @effective_sync_mode = effective_sync_mode
+                @sync_degraded = sync_degraded
+                @sync_acknowledgements = sync_acknowledgements
+                @sync_standby_count = sync_standby_count
+                @sync_state_confirmed = sync_state_confirmed
                 @members = members
             end
 
@@ -21,6 +36,11 @@ module Appwrite
                 DedicatedDatabaseReplicas.new(
                     replicas: map["replicas"],
                     sync_mode: map["syncMode"],
+                    effective_sync_mode: map["effectiveSyncMode"],
+                    sync_degraded: map["syncDegraded"],
+                    sync_acknowledgements: map["syncAcknowledgements"],
+                    sync_standby_count: map["syncStandbyCount"],
+                    sync_state_confirmed: map["syncStateConfirmed"],
                     members: map["members"].map { |it| DedicatedDatabaseMember.from(map: it) }
                 )
             end
@@ -29,6 +49,11 @@ module Appwrite
                 {
                     "replicas": @replicas,
                     "syncMode": @sync_mode,
+                    "effectiveSyncMode": @effective_sync_mode,
+                    "syncDegraded": @sync_degraded,
+                    "syncAcknowledgements": @sync_acknowledgements,
+                    "syncStandbyCount": @sync_standby_count,
+                    "syncStateConfirmed": @sync_state_confirmed,
                     "members": @members.map { |it| it.to_map }
                 }
             end

data/lib/appwrite/models/dedicated_database_specification_pricing.rb

@@ -6,20 +6,17 @@ module Appwrite
             attr_reader :storage_overage_rate
             attr_reader :bandwidth_overage_rate
             attr_reader :replica_rate
-            attr_reader :cross_region_replica_rate
             attr_reader :pitr_rate
 
             def initialize(
                 storage_overage_rate:,
                 bandwidth_overage_rate:,
                 replica_rate:,
-                cross_region_replica_rate:,
                 pitr_rate:
             )
                 @storage_overage_rate = storage_overage_rate
                 @bandwidth_overage_rate = bandwidth_overage_rate
                 @replica_rate = replica_rate
-                @cross_region_replica_rate = cross_region_replica_rate
                 @pitr_rate = pitr_rate
             end
 
@@ -28,7 +25,6 @@ module Appwrite
                     storage_overage_rate: map["storageOverageRate"],
                     bandwidth_overage_rate: map["bandwidthOverageRate"],
                     replica_rate: map["replicaRate"],
-                    cross_region_replica_rate: map["crossRegionReplicaRate"],
                     pitr_rate: map["pitrRate"]
                 )
             end
@@ -38,7 +34,6 @@ module Appwrite
                     "storageOverageRate": @storage_overage_rate,
                     "bandwidthOverageRate": @bandwidth_overage_rate,
                     "replicaRate": @replica_rate,
-                    "crossRegionReplicaRate": @cross_region_replica_rate,
                     "pitrRate": @pitr_rate
                 }
             end