appwrite 21.1.0 → 23.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7d65feccf5827c513e9c2975c3192a9c08538beb3369c13f4cc8687a524df35
-  data.tar.gz: 9067bd506e5b7ae9e4050c327a7c669c842b29a46b063a53a434f11923aa9bf3
+  metadata.gz: 71453fa364510c42ae244dc43108518fd45bcd5eba4409148f181d544f61907e
+  data.tar.gz: '018040e5e8aab6d7ebc649f0754ce43a32cf1a64bebb70c2b5b4c93781c70add'
 SHA512:
-  metadata.gz: 3bb093f2cf13c12960eae3682a0f9c7293a30217636f1ee9baa9b6d5a67739b18df5111a24b9bdfac7fcaa6e8ec1281e67e90e2c910f1a94a581673f42ff7322
-  data.tar.gz: a466eed8fc575662941dcaa7535514ea78111b026bd65bce6d1772a1766bee11963f4cf396b2330e7fb95a11d40549118e236790ab69086e37f28569cdd061e2
+  metadata.gz: bbd44f5cf20c90fe3f628a2badb9ed1766960d3605569475ca36b5bcb32931fbbd8a804e8036fbef454c7d73ff7b52c1c301111777eff84d7780661dbbd5a6c7
+  data.tar.gz: 68008c910bd8e7350dc6cc7b33c692b25ccdc4d8f45df13453ded2456c2b7cd62100838c157160c25d836a6fa5496cf75cb89bb2f5340e78dc5f14b244a11bee

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'=> '23.0.0',
+                'X-Appwrite-Response-Format' => '1.9.1'
             }
             @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
@@ -135,6 +174,13 @@ module Appwrite
             self
         end
 
+        # Get request headers
+        #
+        # @return [Hash]
+        def get_headers
+            @headers.dup
+        end
+
         # Send the HTTP request.
         #
         # @param [String] method The HTTP method for the request

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/build_runtime.rb

@@ -49,6 +49,7 @@ module Appwrite
             DART_3_8 = 'dart-3.8'
             DART_3_9 = 'dart-3.9'
             DART_3_10 = 'dart-3.10'
+            DART_3_11 = 'dart-3.11'
             DOTNET_6_0 = 'dotnet-6.0'
             DOTNET_7_0 = 'dotnet-7.0'
             DOTNET_8_0 = 'dotnet-8.0'
@@ -87,6 +88,7 @@ module Appwrite
             FLUTTER_3_32 = 'flutter-3.32'
             FLUTTER_3_35 = 'flutter-3.35'
             FLUTTER_3_38 = 'flutter-3.38'
+            FLUTTER_3_41 = 'flutter-3.41'
         end
     end
 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/o_auth_provider.rb

@@ -35,6 +35,7 @@ module Appwrite
             TRADESHIFTBOX = 'tradeshiftBox'
             TWITCH = 'twitch'
             WORDPRESS = 'wordpress'
+            X = 'x'
             YAHOO = 'yahoo'
             YAMMER = 'yammer'
             YANDEX = 'yandex'

data/lib/appwrite/enums/platform_type.rb

@@ -0,0 +1,11 @@
+module Appwrite
+    module Enums
+        module PlatformType
+            WINDOWS = 'windows'
+            APPLE = 'apple'
+            ANDROID = 'android'
+            LINUX = 'linux'
+            WEB = 'web'
+        end
+    end
+end

data/lib/appwrite/enums/protocol_id.rb

@@ -0,0 +1,9 @@
+module Appwrite
+    module Enums
+        module ProtocolId
+            REST = 'rest'
+            GRAPHQL = 'graphql'
+            WEBSOCKET = 'websocket'
+        end
+    end
+end

data/lib/appwrite/enums/runtime.rb

@@ -49,6 +49,7 @@ module Appwrite
             DART_3_8 = 'dart-3.8'
             DART_3_9 = 'dart-3.9'
             DART_3_10 = 'dart-3.10'
+            DART_3_11 = 'dart-3.11'
             DOTNET_6_0 = 'dotnet-6.0'
             DOTNET_7_0 = 'dotnet-7.0'
             DOTNET_8_0 = 'dotnet-8.0'
@@ -87,6 +88,7 @@ module Appwrite
             FLUTTER_3_32 = 'flutter-3.32'
             FLUTTER_3_35 = 'flutter-3.35'
             FLUTTER_3_38 = 'flutter-3.38'
+            FLUTTER_3_41 = 'flutter-3.41'
         end
     end
 end

data/lib/appwrite/enums/scopes.rb

@@ -58,6 +58,14 @@ 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'
+            KEYS_READ = 'keys.read'
+            KEYS_WRITE = 'keys.write'
+            PLATFORMS_READ = 'platforms.read'
+            PLATFORMS_WRITE = 'platforms.write'
             POLICIES_WRITE = 'policies.write'
             POLICIES_READ = 'policies.read'
             ARCHIVES_READ = 'archives.read'

data/lib/appwrite/enums/service_id.rb

@@ -0,0 +1,23 @@
+module Appwrite
+    module Enums
+        module ServiceId
+            ACCOUNT = 'account'
+            AVATARS = 'avatars'
+            DATABASES = 'databases'
+            TABLESDB = 'tablesdb'
+            LOCALE = 'locale'
+            HEALTH = 'health'
+            PROJECT = 'project'
+            STORAGE = 'storage'
+            TEAMS = 'teams'
+            USERS = 'users'
+            VCS = 'vcs'
+            SITES = 'sites'
+            FUNCTIONS = 'functions'
+            PROXY = 'proxy'
+            GRAPHQL = 'graphql'
+            MIGRATIONS = 'migrations'
+            MESSAGING = 'messaging'
+        end
+    end
+end

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/auth_provider.rb

@@ -0,0 +1,47 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class AuthProvider
+            attr_reader :key
+            attr_reader :name
+            attr_reader :app_id
+            attr_reader :secret
+            attr_reader :enabled
+
+            def initialize(
+                key:,
+                name:,
+                app_id:,
+                secret:,
+                enabled:
+            )
+                @key = key
+                @name = name
+                @app_id = app_id
+                @secret = secret
+                @enabled = enabled
+            end
+
+            def self.from(map:)
+                AuthProvider.new(
+                    key: map["key"],
+                    name: map["name"],
+                    app_id: map["appId"],
+                    secret: map["secret"],
+                    enabled: map["enabled"]
+                )
+            end
+
+            def to_map
+                {
+                    "key": @key,
+                    "name": @name,
+                    "appId": @app_id,
+                    "secret": @secret,
+                    "enabled": @enabled
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/billing_limits.rb

@@ -0,0 +1,62 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class BillingLimits
+            attr_reader :bandwidth
+            attr_reader :storage
+            attr_reader :users
+            attr_reader :executions
+            attr_reader :gb_hours
+            attr_reader :image_transformations
+            attr_reader :auth_phone
+            attr_reader :budget_limit
+
+            def initialize(
+                bandwidth:,
+                storage:,
+                users:,
+                executions:,
+                gb_hours:,
+                image_transformations:,
+                auth_phone:,
+                budget_limit:
+            )
+                @bandwidth = bandwidth
+                @storage = storage
+                @users = users
+                @executions = executions
+                @gb_hours = gb_hours
+                @image_transformations = image_transformations
+                @auth_phone = auth_phone
+                @budget_limit = budget_limit
+            end
+
+            def self.from(map:)
+                BillingLimits.new(
+                    bandwidth: map["bandwidth"],
+                    storage: map["storage"],
+                    users: map["users"],
+                    executions: map["executions"],
+                    gb_hours: map["GBHours"],
+                    image_transformations: map["imageTransformations"],
+                    auth_phone: map["authPhone"],
+                    budget_limit: map["budgetLimit"]
+                )
+            end
+
+            def to_map
+                {
+                    "bandwidth": @bandwidth,
+                    "storage": @storage,
+                    "users": @users,
+                    "executions": @executions,
+                    "GBHours": @gb_hours,
+                    "imageTransformations": @image_transformations,
+                    "authPhone": @auth_phone,
+                    "budgetLimit": @budget_limit
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/block.rb

@@ -0,0 +1,47 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class Block
+            attr_reader :created_at
+            attr_reader :resource_type
+            attr_reader :resource_id
+            attr_reader :reason
+            attr_reader :expired_at
+
+            def initialize(
+                created_at:,
+                resource_type:,
+                resource_id:,
+                reason: ,
+                expired_at: 
+            )
+                @created_at = created_at
+                @resource_type = resource_type
+                @resource_id = resource_id
+                @reason = reason
+                @expired_at = expired_at
+            end
+
+            def self.from(map:)
+                Block.new(
+                    created_at: map["$createdAt"],
+                    resource_type: map["resourceType"],
+                    resource_id: map["resourceId"],
+                    reason: map["reason"],
+                    expired_at: map["expiredAt"]
+                )
+            end
+
+            def to_map
+                {
+                    "$createdAt": @created_at,
+                    "resourceType": @resource_type,
+                    "resourceId": @resource_id,
+                    "reason": @reason,
+                    "expiredAt": @expired_at
+                }
+            end
+        end
+    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/dev_key.rb

@@ -0,0 +1,62 @@
+#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/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/key.rb

@@ -0,0 +1,67 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class Key
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :name
+            attr_reader :expire
+            attr_reader :scopes
+            attr_reader :secret
+            attr_reader :accessed_at
+            attr_reader :sdks
+
+            def initialize(
+                id:,
+                created_at:,
+                updated_at:,
+                name:,
+                expire:,
+                scopes:,
+                secret:,
+                accessed_at:,
+                sdks:
+            )
+                @id = id
+                @created_at = created_at
+                @updated_at = updated_at
+                @name = name
+                @expire = expire
+                @scopes = scopes
+                @secret = secret
+                @accessed_at = accessed_at
+                @sdks = sdks
+            end
+
+            def self.from(map:)
+                Key.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    name: map["name"],
+                    expire: map["expire"],
+                    scopes: map["scopes"],
+                    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,
+                    "scopes": @scopes,
+                    "secret": @secret,
+                    "accessedAt": @accessed_at,
+                    "sdks": @sdks
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/key_list.rb

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