appwrite 26.1.0 → 27.0.0

data/lib/appwrite/models/embedding.rb

@@ -0,0 +1,42 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class Embedding
+            attr_reader :model
+            attr_reader :dimension
+            attr_reader :embedding
+            attr_reader :error
+
+            def initialize(
+                model:,
+                dimension:,
+                embedding:,
+                error:
+            )
+                @model = model
+                @dimension = dimension
+                @embedding = embedding
+                @error = error
+            end
+
+            def self.from(map:)
+                Embedding.new(
+                    model: map["model"],
+                    dimension: map["dimension"],
+                    embedding: map["embedding"],
+                    error: map["error"]
+                )
+            end
+
+            def to_map
+                {
+                    "model": @model,
+                    "dimension": @dimension,
+                    "embedding": @embedding,
+                    "error": @error
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/embedding_list.rb

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

data/lib/appwrite/models/file.rb

@@ -9,6 +9,8 @@ module Appwrite
             attr_reader :updated_at
             attr_reader :permissions
             attr_reader :name
+            attr_reader :folder
+            attr_reader :key
             attr_reader :signature
             attr_reader :mime_type
             attr_reader :size_original
@@ -25,6 +27,8 @@ module Appwrite
                 updated_at:,
                 permissions:,
                 name:,
+                folder:,
+                key:,
                 signature:,
                 mime_type:,
                 size_original:,
@@ -40,6 +44,8 @@ module Appwrite
                 @updated_at = updated_at
                 @permissions = permissions
                 @name = name
+                @folder = folder
+                @key = key
                 @signature = signature
                 @mime_type = mime_type
                 @size_original = size_original
@@ -58,6 +64,8 @@ module Appwrite
                     updated_at: map["$updatedAt"],
                     permissions: map["$permissions"],
                     name: map["name"],
+                    folder: map["folder"],
+                    key: map["key"],
                     signature: map["signature"],
                     mime_type: map["mimeType"],
                     size_original: map["sizeOriginal"],
@@ -77,6 +85,8 @@ module Appwrite
                     "$updatedAt": @updated_at,
                     "$permissions": @permissions,
                     "name": @name,
+                    "folder": @folder,
+                    "key": @key,
                     "signature": @signature,
                     "mimeType": @mime_type,
                     "sizeOriginal": @size_original,

data/lib/appwrite/models/mfa_challenge_secret.rb

@@ -0,0 +1,47 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class MfaChallengeSecret
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :user_id
+            attr_reader :expire
+            attr_reader :code
+
+            def initialize(
+                id:,
+                created_at:,
+                user_id:,
+                expire:,
+                code:
+            )
+                @id = id
+                @created_at = created_at
+                @user_id = user_id
+                @expire = expire
+                @code = code
+            end
+
+            def self.from(map:)
+                MfaChallengeSecret.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    user_id: map["userId"],
+                    expire: map["expire"],
+                    code: map["code"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "userId": @user_id,
+                    "expire": @expire,
+                    "code": @code
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/mfa_factors.rb

@@ -7,17 +7,20 @@ module Appwrite
             attr_reader :phone
             attr_reader :email
             attr_reader :recovery_code
+            attr_reader :custom
 
             def initialize(
                 totp:,
                 phone:,
                 email:,
-                recovery_code:
+                recovery_code:,
+                custom:
             )
                 @totp = totp
                 @phone = phone
                 @email = email
                 @recovery_code = recovery_code
+                @custom = custom
             end
 
             def self.from(map:)
@@ -25,7 +28,8 @@ module Appwrite
                     totp: map["totp"],
                     phone: map["phone"],
                     email: map["email"],
-                    recovery_code: map["recoveryCode"]
+                    recovery_code: map["recoveryCode"],
+                    custom: map["custom"]
                 )
             end
 
@@ -34,7 +38,8 @@ module Appwrite
                     "totp": @totp,
                     "phone": @phone,
                     "email": @email,
-                    "recoveryCode": @recovery_code
+                    "recoveryCode": @recovery_code,
+                    "custom": @custom
                 }
             end
         end

data/lib/appwrite/models/organization.rb

@@ -46,7 +46,7 @@ module Appwrite
                 name:,
                 total:,
                 prefs:,
-                billing_budget:,
+                billing_budget: ,
                 budget_alerts:,
                 billing_plan:,
                 billing_plan_id:,
@@ -55,23 +55,23 @@ module Appwrite
                 billing_start_date:,
                 billing_current_invoice_date:,
                 billing_next_invoice_date:,
-                billing_trial_start_date:,
+                billing_trial_start_date: ,
                 billing_trial_days:,
                 billing_aggregation_id:,
                 billing_invoice_id:,
                 payment_method_id:,
-                billing_address_id:,
-                backup_payment_method_id:,
+                billing_address_id: ,
+                backup_payment_method_id: ,
                 status:,
-                remarks:,
-                agreement_baa:,
-                program_manager_name:,
-                program_manager_calendar:,
-                program_discord_channel_name:,
-                program_discord_channel_url:,
+                remarks: ,
+                agreement_baa: ,
+                program_manager_name: ,
+                program_manager_calendar: ,
+                program_discord_channel_name: ,
+                program_discord_channel_url: ,
                 billing_limits: ,
-                billing_plan_downgrade:,
-                billing_tax_id:,
+                billing_plan_downgrade: ,
+                billing_tax_id: ,
                 marked_for_deletion:,
                 platform:,
                 projects:

data/lib/appwrite/models/policy_mfa_factors.rb

@@ -0,0 +1,47 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class PolicyMfaFactors
+            attr_reader :id
+            attr_reader :totp
+            attr_reader :email
+            attr_reader :phone
+            attr_reader :custom
+
+            def initialize(
+                id:,
+                totp:,
+                email:,
+                phone:,
+                custom:
+            )
+                @id = id
+                @totp = totp
+                @email = email
+                @phone = phone
+                @custom = custom
+            end
+
+            def self.from(map:)
+                PolicyMfaFactors.new(
+                    id: map["$id"],
+                    totp: map["totp"],
+                    email: map["email"],
+                    phone: map["phone"],
+                    custom: map["custom"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "totp": @totp,
+                    "email": @email,
+                    "phone": @phone,
+                    "custom": @custom
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/project.rb

@@ -36,6 +36,7 @@ module Appwrite
             attr_reader :o_auth2_server_authorization_url
             attr_reader :o_auth2_server_scopes
             attr_reader :o_auth2_server_default_scopes
+            attr_reader :o_auth2_server_installation_scopes
             attr_reader :o_auth2_server_authorization_details_types
             attr_reader :o_auth2_server_access_token_duration
             attr_reader :o_auth2_server_refresh_token_duration
@@ -83,6 +84,7 @@ module Appwrite
                 o_auth2_server_authorization_url: ,
                 o_auth2_server_scopes: ,
                 o_auth2_server_default_scopes: ,
+                o_auth2_server_installation_scopes: ,
                 o_auth2_server_authorization_details_types: ,
                 o_auth2_server_access_token_duration: ,
                 o_auth2_server_refresh_token_duration: ,
@@ -129,6 +131,7 @@ module Appwrite
                 @o_auth2_server_authorization_url = o_auth2_server_authorization_url
                 @o_auth2_server_scopes = o_auth2_server_scopes
                 @o_auth2_server_default_scopes = o_auth2_server_default_scopes
+                @o_auth2_server_installation_scopes = o_auth2_server_installation_scopes
                 @o_auth2_server_authorization_details_types = o_auth2_server_authorization_details_types
                 @o_auth2_server_access_token_duration = o_auth2_server_access_token_duration
                 @o_auth2_server_refresh_token_duration = o_auth2_server_refresh_token_duration
@@ -178,6 +181,7 @@ module Appwrite
                     o_auth2_server_authorization_url: map["oAuth2ServerAuthorizationUrl"],
                     o_auth2_server_scopes: map["oAuth2ServerScopes"],
                     o_auth2_server_default_scopes: map["oAuth2ServerDefaultScopes"],
+                    o_auth2_server_installation_scopes: map["oAuth2ServerInstallationScopes"],
                     o_auth2_server_authorization_details_types: map["oAuth2ServerAuthorizationDetailsTypes"],
                     o_auth2_server_access_token_duration: map["oAuth2ServerAccessTokenDuration"],
                     o_auth2_server_refresh_token_duration: map["oAuth2ServerRefreshTokenDuration"],
@@ -228,6 +232,7 @@ module Appwrite
                     "oAuth2ServerAuthorizationUrl": @o_auth2_server_authorization_url,
                     "oAuth2ServerScopes": @o_auth2_server_scopes,
                     "oAuth2ServerDefaultScopes": @o_auth2_server_default_scopes,
+                    "oAuth2ServerInstallationScopes": @o_auth2_server_installation_scopes,
                     "oAuth2ServerAuthorizationDetailsTypes": @o_auth2_server_authorization_details_types,
                     "oAuth2ServerAccessTokenDuration": @o_auth2_server_access_token_duration,
                     "oAuth2ServerRefreshTokenDuration": @o_auth2_server_refresh_token_duration,

data/lib/appwrite/models/proxy_invalidation.rb

@@ -0,0 +1,42 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class ProxyInvalidation
+            attr_reader :domain
+            attr_reader :type
+            attr_reader :reference
+            attr_reader :status
+
+            def initialize(
+                domain:,
+                type:,
+                reference:,
+                status:
+            )
+                @domain = domain
+                @type = type
+                @reference = reference
+                @status = status
+            end
+
+            def self.from(map:)
+                ProxyInvalidation.new(
+                    domain: map["domain"],
+                    type: map["type"],
+                    reference: map["reference"],
+                    status: map["status"]
+                )
+            end
+
+            def to_map
+                {
+                    "domain": @domain,
+                    "type": @type,
+                    "reference": @reference,
+                    "status": @status
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/usage_billing_plan.rb

@@ -18,15 +18,15 @@ module Appwrite
             def initialize(
                 bandwidth:,
                 executions:,
-                member:,
+                member: ,
                 realtime:,
                 realtime_messages:,
-                realtime_bandwidth:,
+                realtime_bandwidth: ,
                 storage:,
                 users:,
                 gb_hours:,
                 image_transformations:,
-                credits:
+                credits: 
             )
                 @bandwidth = bandwidth
                 @executions = executions
@@ -45,15 +45,15 @@ module Appwrite
                 UsageBillingPlan.new(
                     bandwidth: AdditionalResource.from(map: map["bandwidth"]),
                     executions: AdditionalResource.from(map: map["executions"]),
-                    member: AdditionalResource.from(map: map["member"]),
+                    member: map["member"].nil? ? nil : AdditionalResource.from(map: map["member"]),
                     realtime: AdditionalResource.from(map: map["realtime"]),
                     realtime_messages: AdditionalResource.from(map: map["realtimeMessages"]),
-                    realtime_bandwidth: AdditionalResource.from(map: map["realtimeBandwidth"]),
+                    realtime_bandwidth: map["realtimeBandwidth"].nil? ? nil : AdditionalResource.from(map: map["realtimeBandwidth"]),
                     storage: AdditionalResource.from(map: map["storage"]),
                     users: AdditionalResource.from(map: map["users"]),
                     gb_hours: AdditionalResource.from(map: map["GBHours"]),
                     image_transformations: AdditionalResource.from(map: map["imageTransformations"]),
-                    credits: AdditionalResource.from(map: map["credits"])
+                    credits: map["credits"].nil? ? nil : AdditionalResource.from(map: map["credits"])
                 )
             end
 
@@ -61,15 +61,15 @@ module Appwrite
                 {
                     "bandwidth": @bandwidth.to_map,
                     "executions": @executions.to_map,
-                    "member": @member.to_map,
+                    "member": @member&.to_map,
                     "realtime": @realtime.to_map,
                     "realtimeMessages": @realtime_messages.to_map,
-                    "realtimeBandwidth": @realtime_bandwidth.to_map,
+                    "realtimeBandwidth": @realtime_bandwidth&.to_map,
                     "storage": @storage.to_map,
                     "users": @users.to_map,
                     "GBHours": @gb_hours.to_map,
                     "imageTransformations": @image_transformations.to_map,
-                    "credits": @credits.to_map
+                    "credits": @credits&.to_map
                 }
             end
         end

data/lib/appwrite/services/account.rb

@@ -397,38 +397,6 @@ module Appwrite
 
         end
 
-        # Use this endpoint to create a JSON Web Token. You can use the resulting JWT
-        # to authenticate on behalf of the current user when working with the
-        # Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes
-        # from its creation and will be invalid if the user will logout in that time
-        # frame.
-        #
-        # @param [Integer] duration Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
-        #
-        # @return [Jwt]
-        def create_jwt(duration: nil)
-            api_path = '/account/jwts'
-
-            api_params = {
-                duration: duration,
-            }
-            
-            api_headers = {
-                "X-Appwrite-Project": @client.get_config('project'),
-                "content-type": 'application/json',
-                "accept": 'application/json',
-            }
-
-            @client.call(
-                method: 'POST',
-                path: api_path,
-                headers: api_headers,
-                params: api_params,
-                response_type: Models::Jwt
-            )
-
-        end
-
         # Get the list of latest security activity logs for the currently logged in
         # user. Each log returns user IP address, location and date and time of log.
         #
@@ -600,7 +568,7 @@ module Appwrite
         # [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
         # method.
         #
-        # @param [AuthenticationFactor] factor Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.
+        # @param [AuthenticationFactor] factor Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`, `custom`.
         #
         # @return [MfaChallenge]
         def create_mfa_challenge(factor:)

data/lib/appwrite/services/activities.rb

@@ -9,7 +9,7 @@ module Appwrite
 
         # List all events for selected filters.
         #
-        # @param [String] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as userId, teamId, etc.
+        # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as userId, teamId, etc.
         #
         # @return [ActivityEventList]
         def list_events(queries: nil)

data/lib/appwrite/services/apps.rb

@@ -164,7 +164,7 @@ module Appwrite
 
         # Get an application by its unique ID.
         #
-        # @param [String] app_id Application unique ID or HTTPS client ID metadata document URL.
+        # @param [String] app_id Application unique ID.
         #
         # @return [App]
         def get(app_id:)
@@ -213,7 +213,7 @@ module Appwrite
         # @param [Array] post_logout_redirect_uris Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.
         # @param [String] type OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` — PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.
         # @param [] device_flow Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.
-        # @param [Array] installation_scopes Scopes the application requests when installed on a team. Organization-level and project-level scopes only; use the list scopes endpoint with `type=installation` to discover available values. Maximum of 100 scopes are allowed.
+        # @param [Array] installation_scopes Scopes the application requests when installed on a team. Only scopes allowed by the project's OAuth2 server installation scopes configuration are accepted; use the list installation scopes endpoint to discover available values. Maximum of 100 scopes are allowed.
         # @param [String] installation_redirect_url URL users are redirected to after creating or updating an installation of this application. Must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI, and must not contain a fragment. Leave empty for no redirect.
         #
         # @return [App]
@@ -299,7 +299,8 @@ module Appwrite
         end
 
         # List installations of an application. Requires an app key sent in the
-        # `X-Appwrite-Key` header alongside the `X-Appwrite-App` header.
+        # `X-Appwrite-Key` header alongside the `X-Appwrite-App` header, or a caller
+        # with update access to the app.
         #
         # @param [String] app_id Application unique ID.
         # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
@@ -335,7 +336,8 @@ module Appwrite
         end
 
         # Get an installation of an application by its unique ID. Requires an app key
-        # sent in the `X-Appwrite-Key` header alongside the `X-Appwrite-App` header.
+        # sent in the `X-Appwrite-Key` header alongside the `X-Appwrite-App` header,
+        # or a caller with update access to the app.
         #
         # @param [String] app_id Application unique ID.
         # @param [String] installation_id Installation unique ID.
@@ -372,13 +374,53 @@ module Appwrite
 
         end
 
+        # Delete an installation of an application by its unique ID. Requires a
+        # caller with update access to the app. Previously issued installation access
+        # tokens are revoked.
+        #
+        # @param [String] app_id Application unique ID.
+        # @param [String] installation_id Installation unique ID.
+        #
+        # @return []
+        def delete_installation(app_id:, installation_id:)
+            api_path = '/apps/{appId}/installations/{installationId}'
+                .gsub('{appId}', app_id)
+                .gsub('{installationId}', installation_id)
+
+            if app_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "appId"')
+            end
+
+            if installation_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'DELETE',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+            )
+
+        end
+
         # Create a token for an installation of an application. Requires an app key
-        # sent in the `X-Appwrite-Key` header alongside the `X-Appwrite-App` header.
-        # The returned token carries the scopes and authorization details granted to
-        # the installation, and can be used as an `Authorization: Bearer` header
-        # everywhere OAuth2 access tokens are accepted. Multiple tokens can be active
-        # for the same installation at once; each token stays valid until it expires
-        # or the installation is updated or deleted.
+        # sent in the `X-Appwrite-Key` header alongside the `X-Appwrite-App` header,
+        # or a caller with update access to the app. The returned token carries the
+        # scopes and authorization details granted to the installation, and can be
+        # used as an `Authorization: Bearer` header everywhere OAuth2 access tokens
+        # are accepted. Multiple tokens can be active for the same installation at
+        # once; each token stays valid until it expires or the installation is
+        # updated or deleted.
         #
         # @param [String] app_id Application unique ID.
         # @param [String] installation_id Installation unique ID.

data/lib/appwrite/services/backups.rb

@@ -318,9 +318,10 @@ module Appwrite
         # Create and trigger a new restoration for a backup on a project.
         # 
         # For a backup of one database, the restoration resolves its destination
-        # before it is queued. Pass `newResourceId` to restore into that database ID,
-        # including the archived database ID to overwrite it. When `newResourceId` is
-        # omitted, a new database ID is generated and returned in `options`.
+        # before it is queued. When `newResourceId` is omitted, the archived database
+        # is restored in place and its own ID is returned in `options`. Pass a
+        # different `newResourceId` to restore alongside it as a new database
+        # instead.
         # 
         # The restoration migration records the archived database in `resourceId` and
         # `resourceType`, and the resolved database in `destinationResourceId` and
@@ -337,14 +338,19 @@ module Appwrite
         # operational `resourceType` of a table migration is not rewritten to
         # `tablesdb`.
         # 
-        # When restoring a DocumentsDB or VectorsDB database to a new resource from a
-        # dedicated source, the restore provisions a fresh dedicated backing database
-        # at the source database's own specification.
+        # When restoring a DocumentsDB or VectorsDB database from a dedicated source,
+        # the restore provisions a fresh dedicated backing database at the source
+        # database's own specification and lands the data there. An in-place restore
+        # swaps the database onto that backing only once the restore has succeeded,
+        # and retires the backing it displaced only once that swap is confirmed, so
+        # the source keeps serving its own data until the restored data is in place
+        # and any failure leaves it untouched. A serverless source has no dedicated
+        # backing to clone and restores onto the archived database instead.
         # 
         #
         # @param [String] archive_id Backup archive ID to restore
         # @param [Array] services Array of services to restore
-        # @param [String] new_resource_id Destination resource ID. Omit to generate a new ID, or pass the archived resource ID to overwrite it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+        # @param [String] new_resource_id Destination resource ID. Omit to restore the archived resource in place, or pass a different ID to restore alongside it as a new resource. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
         # @param [String] new_resource_name Database name. Max length: 128 chars.
         #
         # @return [BackupRestoration]