appwrite 24.2.0 → 25.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1815561145e36dee35678ad27a1bbdf13c53ed1fad59dd8c07805321f6073627
-  data.tar.gz: a4c4d5cf12077a7eedfb240b13c632040f3f8d220421704156b9cc07353e687f
+  metadata.gz: dfd2490881b125f29ab7d8d65ac5934317484bfbc15a0793f512f3cc9d464d76
+  data.tar.gz: 7880fbf970bb0fd2a39da4e2a9ffa1435628f1525f9dbcd1ab37ab8a67752c57
 SHA512:
-  metadata.gz: '018c916f75afc5a11b45837d4498b371241156e5a765903815a6bfbefaf848b15b457b0988e384a3331b51c8cc291c52c9a0015bec63960ed73aee57f1886d8f'
-  data.tar.gz: 2274734af1f1c1434d2aa945d84d6ca704d7c155e633b2c71e58f086c69809b1c46af12a703769d46a3d087291eb22854dd57718ccc8c7e09eb7fb8017f0a628
+  metadata.gz: c8dc0aeb0e1670c64ab2f605b6fefc7185a523dac9597982db580794ebf13f06d6c6481383cc635a68fdc247ec800f72eb081fc9f828e873ce255ef0cd8e4b6d
+  data.tar.gz: b322e85c4907fd3bc68501b3cef4272e877696edb0efc4d53168bb648782a7e951bae8eb7999c088daa7755e8483f0c38b634ff51be965166270dba87be1f7ff

data/lib/appwrite/client.rb

@@ -15,7 +15,7 @@ module Appwrite
                 'x-sdk-name'=> 'Ruby',
                 'x-sdk-platform'=> 'server',
                 'x-sdk-language'=> 'ruby',
-                'x-sdk-version'=> '24.2.0',
+                'x-sdk-version'=> '25.0.0',
                 'X-Appwrite-Response-Format' => '1.9.5'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'

data/lib/appwrite/enums/backup_services.rb

@@ -5,6 +5,7 @@ module Appwrite
             TABLESDB = 'tablesdb'
             DOCUMENTSDB = 'documentsdb'
             VECTORSDB = 'vectorsdb'
+            DEDICATEDDATABASES = 'dedicatedDatabases'
             FUNCTIONS = 'functions'
             STORAGE = 'storage'
         end

data/lib/appwrite/enums/{theme.rb → browser_theme.rb}

@@ -1,6 +1,6 @@
 module Appwrite
     module Enums
-        module Theme
+        module BrowserTheme
             LIGHT = 'light'
             DARK = 'dark'
         end

data/lib/appwrite/enums/build_runtime.rb

@@ -32,9 +32,6 @@ module Appwrite
             PYTHON_ML_3_11 = 'python-ml-3.11'
             PYTHON_ML_3_12 = 'python-ml-3.12'
             PYTHON_ML_3_13 = 'python-ml-3.13'
-            DENO_1_21 = 'deno-1.21'
-            DENO_1_24 = 'deno-1.24'
-            DENO_1_35 = 'deno-1.35'
             DENO_1_40 = 'deno-1.40'
             DENO_1_46 = 'deno-1.46'
             DENO_2_0 = 'deno-2.0'
@@ -53,6 +50,7 @@ module Appwrite
             DART_3_9 = 'dart-3.9'
             DART_3_10 = 'dart-3.10'
             DART_3_11 = 'dart-3.11'
+            DART_3_12 = 'dart-3.12'
             DOTNET_6_0 = 'dotnet-6.0'
             DOTNET_7_0 = 'dotnet-7.0'
             DOTNET_8_0 = 'dotnet-8.0'
@@ -93,6 +91,7 @@ module Appwrite
             FLUTTER_3_35 = 'flutter-3.35'
             FLUTTER_3_38 = 'flutter-3.38'
             FLUTTER_3_41 = 'flutter-3.41'
+            FLUTTER_3_44 = 'flutter-3.44'
         end
     end
 end

data/lib/appwrite/enums/{name.rb → health_queue_name.rb}

@@ -1,6 +1,6 @@
 module Appwrite
     module Enums
-        module Name
+        module HealthQueueName
             V1_DATABASE = 'v1-database'
             V1_DELETES = 'v1-deletes'
             V1_AUDITS = 'v1-audits'

data/lib/appwrite/enums/organization_key_scopes.rb

@@ -0,0 +1,16 @@
+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'
+            DOMAINS_READ = 'domains.read'
+            DOMAINS_WRITE = 'domains.write'
+            KEYS_READ = 'keys.read'
+            KEYS_WRITE = 'keys.write'
+        end
+    end
+end

data/lib/appwrite/enums/project_o_auth_provider_id.rb

@@ -44,8 +44,6 @@ module Appwrite
             YANDEX = 'yandex'
             ZOHO = 'zoho'
             ZOOM = 'zoom'
-            GITHUBIMAGINE = 'githubImagine'
-            GOOGLEIMAGINE = 'googleImagine'
         end
     end
 end

data/lib/appwrite/enums/project_policy_id.rb

@@ -10,6 +10,9 @@ module Appwrite
             SESSION_LIMIT = 'session-limit'
             USER_LIMIT = 'user-limit'
             MEMBERSHIP_PRIVACY = 'membership-privacy'
+            DENY_ALIASED_EMAIL = 'deny-aliased-email'
+            DENY_DISPOSABLE_EMAIL = 'deny-disposable-email'
+            DENY_FREE_EMAIL = 'deny-free-email'
         end
     end
 end

data/lib/appwrite/enums/region.rb

@@ -0,0 +1,12 @@
+module Appwrite
+    module Enums
+        module Region
+            FRA = 'fra'
+            NYC = 'nyc'
+            SYD = 'syd'
+            SFO = 'sfo'
+            SGP = 'sgp'
+            TOR = 'tor'
+        end
+    end
+end

data/lib/appwrite/enums/runtime.rb

@@ -32,9 +32,6 @@ module Appwrite
             PYTHON_ML_3_11 = 'python-ml-3.11'
             PYTHON_ML_3_12 = 'python-ml-3.12'
             PYTHON_ML_3_13 = 'python-ml-3.13'
-            DENO_1_21 = 'deno-1.21'
-            DENO_1_24 = 'deno-1.24'
-            DENO_1_35 = 'deno-1.35'
             DENO_1_40 = 'deno-1.40'
             DENO_1_46 = 'deno-1.46'
             DENO_2_0 = 'deno-2.0'
@@ -53,6 +50,7 @@ module Appwrite
             DART_3_9 = 'dart-3.9'
             DART_3_10 = 'dart-3.10'
             DART_3_11 = 'dart-3.11'
+            DART_3_12 = 'dart-3.12'
             DOTNET_6_0 = 'dotnet-6.0'
             DOTNET_7_0 = 'dotnet-7.0'
             DOTNET_8_0 = 'dotnet-8.0'
@@ -93,6 +91,7 @@ module Appwrite
             FLUTTER_3_35 = 'flutter-3.35'
             FLUTTER_3_38 = 'flutter-3.38'
             FLUTTER_3_41 = 'flutter-3.41'
+            FLUTTER_3_44 = 'flutter-3.44'
         end
     end
 end

data/lib/appwrite/enums/status_code.rb

@@ -1,10 +1,10 @@
 module Appwrite
     module Enums
         module StatusCode
-            MOVED_PERMANENTLY_301 = '301'
-            FOUND_302 = '302'
-            TEMPORARY_REDIRECT_307 = '307'
-            PERMANENT_REDIRECT_308 = '308'
+            MOVEDPERMANENTLY = '301'
+            FOUND = '302'
+            TEMPORARYREDIRECT = '307'
+            PERMANENTREDIRECT = '308'
         end
     end
 end

data/lib/appwrite/models/activity_event.rb

@@ -4,10 +4,10 @@ module Appwrite
     module Models
         class ActivityEvent
             attr_reader :id
-            attr_reader :user_type
-            attr_reader :user_id
-            attr_reader :user_email
-            attr_reader :user_name
+            attr_reader :actor_type
+            attr_reader :actor_id
+            attr_reader :actor_email
+            attr_reader :actor_name
             attr_reader :resource_parent
             attr_reader :resource_type
             attr_reader :resource_id
@@ -38,10 +38,10 @@ module Appwrite
 
             def initialize(
                 id:,
-                user_type:,
-                user_id:,
-                user_email:,
-                user_name:,
+                actor_type:,
+                actor_id:,
+                actor_email:,
+                actor_name:,
                 resource_parent:,
                 resource_type:,
                 resource_id:,
@@ -71,10 +71,10 @@ module Appwrite
                 country_name:
             )
                 @id = id
-                @user_type = user_type
-                @user_id = user_id
-                @user_email = user_email
-                @user_name = user_name
+                @actor_type = actor_type
+                @actor_id = actor_id
+                @actor_email = actor_email
+                @actor_name = actor_name
                 @resource_parent = resource_parent
                 @resource_type = resource_type
                 @resource_id = resource_id
@@ -107,10 +107,10 @@ module Appwrite
             def self.from(map:)
                 ActivityEvent.new(
                     id: map["$id"],
-                    user_type: map["userType"],
-                    user_id: map["userId"],
-                    user_email: map["userEmail"],
-                    user_name: map["userName"],
+                    actor_type: map["actorType"],
+                    actor_id: map["actorId"],
+                    actor_email: map["actorEmail"],
+                    actor_name: map["actorName"],
                     resource_parent: map["resourceParent"],
                     resource_type: map["resourceType"],
                     resource_id: map["resourceId"],
@@ -144,10 +144,10 @@ module Appwrite
             def to_map
                 {
                     "$id": @id,
-                    "userType": @user_type,
-                    "userId": @user_id,
-                    "userEmail": @user_email,
-                    "userName": @user_name,
+                    "actorType": @actor_type,
+                    "actorId": @actor_id,
+                    "actorEmail": @actor_email,
+                    "actorName": @actor_name,
                     "resourceParent": @resource_parent,
                     "resourceType": @resource_type,
                     "resourceId": @resource_id,

data/lib/appwrite/models/function.rb

@@ -31,6 +31,8 @@ module Appwrite
             attr_reader :provider_branch
             attr_reader :provider_root_directory
             attr_reader :provider_silent_mode
+            attr_reader :provider_branches
+            attr_reader :provider_paths
             attr_reader :build_specification
             attr_reader :runtime_specification
 
@@ -63,6 +65,8 @@ module Appwrite
                 provider_branch:,
                 provider_root_directory:,
                 provider_silent_mode:,
+                provider_branches:,
+                provider_paths:,
                 build_specification:,
                 runtime_specification:
             )
@@ -94,6 +98,8 @@ module Appwrite
                 @provider_branch = provider_branch
                 @provider_root_directory = provider_root_directory
                 @provider_silent_mode = provider_silent_mode
+                @provider_branches = provider_branches
+                @provider_paths = provider_paths
                 @build_specification = build_specification
                 @runtime_specification = runtime_specification
             end
@@ -128,6 +134,8 @@ module Appwrite
                     provider_branch: map["providerBranch"],
                     provider_root_directory: map["providerRootDirectory"],
                     provider_silent_mode: map["providerSilentMode"],
+                    provider_branches: map["providerBranches"],
+                    provider_paths: map["providerPaths"],
                     build_specification: map["buildSpecification"],
                     runtime_specification: map["runtimeSpecification"]
                 )
@@ -163,6 +171,8 @@ module Appwrite
                     "providerBranch": @provider_branch,
                     "providerRootDirectory": @provider_root_directory,
                     "providerSilentMode": @provider_silent_mode,
+                    "providerBranches": @provider_branches,
+                    "providerPaths": @provider_paths,
                     "buildSpecification": @build_specification,
                     "runtimeSpecification": @runtime_specification
                 }

data/lib/appwrite/models/policy_deny_aliased_email.rb

@@ -0,0 +1,32 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class PolicyDenyAliasedEmail
+            attr_reader :id
+            attr_reader :enabled
+
+            def initialize(
+                id:,
+                enabled:
+            )
+                @id = id
+                @enabled = enabled
+            end
+
+            def self.from(map:)
+                PolicyDenyAliasedEmail.new(
+                    id: map["$id"],
+                    enabled: map["enabled"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "enabled": @enabled
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/policy_deny_disposable_email.rb

@@ -0,0 +1,32 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class PolicyDenyDisposableEmail
+            attr_reader :id
+            attr_reader :enabled
+
+            def initialize(
+                id:,
+                enabled:
+            )
+                @id = id
+                @enabled = enabled
+            end
+
+            def self.from(map:)
+                PolicyDenyDisposableEmail.new(
+                    id: map["$id"],
+                    enabled: map["enabled"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "enabled": @enabled
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/policy_deny_free_email.rb

@@ -0,0 +1,32 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class PolicyDenyFreeEmail
+            attr_reader :id
+            attr_reader :enabled
+
+            def initialize(
+                id:,
+                enabled:
+            )
+                @id = id
+                @enabled = enabled
+            end
+
+            def self.from(map:)
+                PolicyDenyFreeEmail.new(
+                    id: map["$id"],
+                    enabled: map["enabled"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "enabled": @enabled
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/presence.rb

@@ -22,7 +22,7 @@ module Appwrite
                 status: ,
                 source:,
                 expires_at: ,
-                metadata:
+                metadata: 
             )
                 @id = id
                 @created_at = created_at
@@ -45,7 +45,7 @@ module Appwrite
                     status: map["status"],
                     source: map["source"],
                     expires_at: map["expiresAt"],
-                    metadata: map["metadata"] || map
+                    metadata: map["metadata"]
                 )
             end
 
@@ -62,10 +62,6 @@ module Appwrite
                     "metadata": @metadata
                 }
             end
-
-            def convert_to(from_json)
-                from_json.call(metadata)
-            end
         end
     end
 end

data/lib/appwrite/models/presence_list.rb

@@ -27,10 +27,6 @@ module Appwrite
                     "presences": @presences.map { |it| it.to_map }
                 }
             end
-
-            def convert_to(from_json)
-                presences.map { |it| it.convert_to(from_json) }
-            end
         end
     end
 end

data/lib/appwrite/models/project_list.rb

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

data/lib/appwrite/models/site.rb

@@ -30,6 +30,8 @@ module Appwrite
             attr_reader :provider_branch
             attr_reader :provider_root_directory
             attr_reader :provider_silent_mode
+            attr_reader :provider_branches
+            attr_reader :provider_paths
             attr_reader :build_specification
             attr_reader :runtime_specification
             attr_reader :build_runtime
@@ -64,6 +66,8 @@ module Appwrite
                 provider_branch:,
                 provider_root_directory:,
                 provider_silent_mode:,
+                provider_branches:,
+                provider_paths:,
                 build_specification:,
                 runtime_specification:,
                 build_runtime:,
@@ -97,6 +101,8 @@ module Appwrite
                 @provider_branch = provider_branch
                 @provider_root_directory = provider_root_directory
                 @provider_silent_mode = provider_silent_mode
+                @provider_branches = provider_branches
+                @provider_paths = provider_paths
                 @build_specification = build_specification
                 @runtime_specification = runtime_specification
                 @build_runtime = build_runtime
@@ -133,6 +139,8 @@ module Appwrite
                     provider_branch: map["providerBranch"],
                     provider_root_directory: map["providerRootDirectory"],
                     provider_silent_mode: map["providerSilentMode"],
+                    provider_branches: map["providerBranches"],
+                    provider_paths: map["providerPaths"],
                     build_specification: map["buildSpecification"],
                     runtime_specification: map["runtimeSpecification"],
                     build_runtime: map["buildRuntime"],
@@ -170,6 +178,8 @@ module Appwrite
                     "providerBranch": @provider_branch,
                     "providerRootDirectory": @provider_root_directory,
                     "providerSilentMode": @provider_silent_mode,
+                    "providerBranches": @provider_branches,
+                    "providerPaths": @provider_paths,
                     "buildSpecification": @build_specification,
                     "runtimeSpecification": @runtime_specification,
                     "buildRuntime": @build_runtime,

data/lib/appwrite/models/usage_gauge.rb

@@ -6,22 +6,30 @@ module Appwrite
             attr_reader :metric
             attr_reader :value
             attr_reader :time
+            attr_reader :resource_type
+            attr_reader :resource_id
 
             def initialize(
                 metric:,
                 value:,
-                time:
+                time:,
+                resource_type:,
+                resource_id:
             )
                 @metric = metric
                 @value = value
                 @time = time
+                @resource_type = resource_type
+                @resource_id = resource_id
             end
 
             def self.from(map:)
                 UsageGauge.new(
                     metric: map["metric"],
                     value: map["value"],
-                    time: map["time"]
+                    time: map["time"],
+                    resource_type: map["resourceType"],
+                    resource_id: map["resourceId"]
                 )
             end
 
@@ -29,7 +37,9 @@ module Appwrite
                 {
                     "metric": @metric,
                     "value": @value,
-                    "time": @time
+                    "time": @time,
+                    "resourceType": @resource_type,
+                    "resourceId": @resource_id
                 }
             end
         end

data/lib/appwrite/services/avatars.rb

@@ -305,7 +305,7 @@ module Appwrite
         # @param [Integer] viewport_width Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
         # @param [Integer] viewport_height Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
         # @param [Float] scale Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
-        # @param [Theme] theme Browser theme. Pass "light" or "dark". Defaults to "light".
+        # @param [BrowserTheme] theme Browser theme. Pass "light" or "dark". Defaults to "light".
         # @param [String] user_agent Custom user agent string. Defaults to browser default.
         # @param [] fullpage Capture full page scroll. Pass 0 for viewport only, or 1 for full page. Defaults to 0.
         # @param [String] locale Browser locale (e.g., "en-US", "fr-FR"). Defaults to browser default.

data/lib/appwrite/services/functions.rb

@@ -59,12 +59,14 @@ 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 [Array] provider_branches List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.
+        # @param [Array] provider_paths List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.
         # @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, build_specification: nil, runtime_specification: nil, deployment_retention: 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, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/functions'
 
             if function_id.nil?
@@ -97,6 +99,8 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
+                providerBranches: provider_branches,
+                providerPaths: provider_paths,
                 buildSpecification: build_specification,
                 runtimeSpecification: runtime_specification,
                 deploymentRetention: deployment_retention,
@@ -210,12 +214,14 @@ 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 [Array] provider_branches List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.
+        # @param [Array] provider_paths List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.
         # @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, build_specification: nil, runtime_specification: nil, deployment_retention: 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, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
             api_path = '/functions/{functionId}'
                 .gsub('{functionId}', function_id)
 
@@ -244,6 +250,8 @@ module Appwrite
                 providerBranch: provider_branch,
                 providerSilentMode: provider_silent_mode,
                 providerRootDirectory: provider_root_directory,
+                providerBranches: provider_branches,
+                providerPaths: provider_paths,
                 buildSpecification: build_specification,
                 runtimeSpecification: runtime_specification,
                 deploymentRetention: deployment_retention,

data/lib/appwrite/services/health.rb

@@ -314,7 +314,7 @@ module Appwrite
         # Returns the amount of failed jobs in a given queue.
         # 
         #
-        # @param [Name] name The name of the queue
+        # @param [HealthQueueName] name The name of the queue
         # @param [Integer] threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
         #
         # @return [HealthQueue]