appwrite 25.1.0 → 26.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc6d0070b3940ca846d8ecb461dacbdb9f078abd2086afc9b9e42febc14df663
-  data.tar.gz: 466949abf687dfb27cbc1ff60304612082f5df2a3e453032f3016dfdcaa47947
+  metadata.gz: '02891ab1059978945c4a148b229e240f171612f8cfe7ed5d677ddc965796439e'
+  data.tar.gz: 390bb97d112b72b6baeb7a2d9d1d38f155bedb6136b2d326e8d62ce3fad44476
 SHA512:
-  metadata.gz: 185be5d32ebd73c3160bfc2ddd2c0987cf06315a4306c18108202f189b83379ab78f71b4fd745e9fc3ece72c9a74f000a4f295f3c90b560b69557179594bbe99
-  data.tar.gz: d44619e35df9c1521abb70959cb7659e326ac13dd3f79a89a32896390835ca2de2c434ae18c1507fd5c6a7a28579275870c9ea4b06edd162e9e9aeb9e1f2ad02
+  metadata.gz: 75ccab76ec05a49ead852f078afe07efbbee3b73b09820737597298e5a0b403d3f5deca9572dd41f0c4a0fd09cae1f98b3ed76ae0025370213b915d3d9aa7b2f
+  data.tar.gz: baf6dd1c0e4522e91a5079404619e1df15d221904ef1c7646ede6a3068bbe085167e285cfc6fd27f1cb3f5f3ec2fe7b85f9cb68f4893b8cd46bcd54a186e5d74

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'=> '25.1.0',
+                'x-sdk-version'=> '26.1.0',
                 'X-Appwrite-Response-Format' => '1.9.5'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'
@@ -63,6 +63,20 @@ module Appwrite
             self
         end
 
+        # Set Bearer
+        #
+        # The OAuth access token to authenticate with
+        #
+        # @param [String] value The value to set for the Bearer header
+        #
+        # @return [self]
+        def set_bearer(value)
+            add_header('authorization', "Bearer #{value}")
+            @config['bearer'] = value
+
+            self
+        end
+
         # Set Locale
         #
         # @param [String] value The value to set for the Locale header
@@ -133,7 +147,7 @@ module Appwrite
 
         # 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.
+        # Impersonate a user by ID
         #
         # @param [String] value The value to set for the ImpersonateUserId header
         #
@@ -147,7 +161,7 @@ module Appwrite
 
         # 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.
+        # Impersonate a user by email
         #
         # @param [String] value The value to set for the ImpersonateUserEmail header
         #
@@ -161,7 +175,7 @@ module Appwrite
 
         # 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.
+        # Impersonate a user by phone
         #
         # @param [String] value The value to set for the ImpersonateUserPhone header
         #

data/lib/appwrite/enums/billing_plan_group.rb

@@ -0,0 +1,9 @@
+module Appwrite
+    module Enums
+        module BillingPlanGroup
+            STARTER = 'starter'
+            PRO = 'pro'
+            SCALE = 'scale'
+        end
+    end
+end

data/lib/appwrite/enums/database_status.rb

@@ -0,0 +1,20 @@
+module Appwrite
+    module Enums
+        module DatabaseStatus
+            PROVISIONING = 'provisioning'
+            READY = 'ready'
+            INACTIVE = 'inactive'
+            PAUSED = 'paused'
+            FAILED = 'failed'
+            DELETING = 'deleting'
+            DELETED = 'deleted'
+            RESTORING = 'restoring'
+            SCALING = 'scaling'
+            UPGRADING = 'upgrading'
+            MIGRATING = 'migrating'
+            PAUSING = 'pausing'
+            RESUMING = 'resuming'
+            FAILING_OVER = 'failing-over'
+        end
+    end
+end

data/lib/appwrite/enums/database_type.rb

@@ -5,6 +5,9 @@ module Appwrite
             TABLESDB = 'tablesdb'
             DOCUMENTSDB = 'documentsdb'
             VECTORSDB = 'vectorsdb'
+            MYSQL = 'mysql'
+            POSTGRESQL = 'postgresql'
+            MONGODB = 'mongodb'
         end
     end
 end

data/lib/appwrite/enums/o_auth2_oidc_prompt.rb

@@ -0,0 +1,10 @@
+module Appwrite
+    module Enums
+        module OAuth2OidcPrompt
+            NONE = 'none'
+            LOGIN = 'login'
+            CONSENT = 'consent'
+            SELECT_ACCOUNT = 'select_account'
+        end
+    end
+end

data/lib/appwrite/enums/o_auth_provider.rb

@@ -3,6 +3,7 @@ module Appwrite
         module OAuthProvider
             AMAZON = 'amazon'
             APPLE = 'apple'
+            APPWRITE = 'appwrite'
             AUTH0 = 'auth0'
             AUTHENTIK = 'authentik'
             AUTODESK = 'autodesk'

data/lib/appwrite/enums/organization_key_scopes.rb

@@ -7,6 +7,12 @@ module Appwrite
             DEVKEYS_WRITE = 'devKeys.write'
             ORGANIZATION_KEYS_READ = 'organization.keys.read'
             ORGANIZATION_KEYS_WRITE = 'organization.keys.write'
+            ORGANIZATION_INSTALLATIONS_READ = 'organization.installations.read'
+            ORGANIZATION_INSTALLATIONS_WRITE = 'organization.installations.write'
+            ORGANIZATION_MEMBERSHIPS_READ = 'organization.memberships.read'
+            ORGANIZATION_MEMBERSHIPS_WRITE = 'organization.memberships.write'
+            ORGANIZATION_READ = 'organization.read'
+            ORGANIZATION_WRITE = 'organization.write'
             DOMAINS_READ = 'domains.read'
             DOMAINS_WRITE = 'domains.write'
             KEYS_READ = 'keys.read'

data/lib/appwrite/enums/project_key_scopes.rb

@@ -13,10 +13,12 @@ module Appwrite
             POLICIES_WRITE = 'policies.write'
             PROJECT_POLICIES_READ = 'project.policies.read'
             PROJECT_POLICIES_WRITE = 'project.policies.write'
+            PROJECT_OAUTH2_READ = 'project.oauth2.read'
+            PROJECT_OAUTH2_WRITE = 'project.oauth2.write'
             TEMPLATES_READ = 'templates.read'
             TEMPLATES_WRITE = 'templates.write'
-            OAUTH2_READ = 'oauth2.read'
-            OAUTH2_WRITE = 'oauth2.write'
+            STAGES_READ = 'stages.read'
+            STAGES_WRITE = 'stages.write'
             USERS_READ = 'users.read'
             USERS_WRITE = 'users.write'
             SESSIONS_READ = 'sessions.read'
@@ -91,11 +93,17 @@ module Appwrite
             ARCHIVES_WRITE = 'archives.write'
             RESTORATIONS_READ = 'restorations.read'
             RESTORATIONS_WRITE = 'restorations.write'
+            DEDICATEDDATABASES_EXECUTE = 'dedicatedDatabases.execute'
             DOMAINS_READ = 'domains.read'
             DOMAINS_WRITE = 'domains.write'
+            WAFRULES_READ = 'wafRules.read'
+            WAFRULES_WRITE = 'wafRules.write'
             EVENTS_READ = 'events.read'
             APPS_READ = 'apps.read'
             APPS_WRITE = 'apps.write'
+            OAUTH2_READ = 'oauth2.read'
+            OAUTH2_WRITE = 'oauth2.write'
+            OAUTH2_INTROSPECT = 'oauth2.introspect'
             USAGE_READ = 'usage.read'
         end
     end

data/lib/appwrite/enums/project_o_auth2_oidc_prompt.rb

@@ -0,0 +1,10 @@
+module Appwrite
+    module Enums
+        module ProjectOAuth2OidcPrompt
+            NONE = 'none'
+            LOGIN = 'login'
+            CONSENT = 'consent'
+            SELECT_ACCOUNT = 'select_account'
+        end
+    end
+end

data/lib/appwrite/enums/project_o_auth_provider_id.rb

@@ -3,6 +3,7 @@ module Appwrite
         module ProjectOAuthProviderId
             AMAZON = 'amazon'
             APPLE = 'apple'
+            APPWRITE = 'appwrite'
             AUTH0 = 'auth0'
             AUTHENTIK = 'authentik'
             AUTODESK = 'autodesk'

data/lib/appwrite/enums/project_policy_id.rb

@@ -14,6 +14,7 @@ module Appwrite
             DENY_ALIASED_EMAIL = 'deny-aliased-email'
             DENY_DISPOSABLE_EMAIL = 'deny-disposable-email'
             DENY_FREE_EMAIL = 'deny-free-email'
+            DENY_CORPORATE_EMAIL = 'deny-corporate-email'
         end
     end
 end

data/lib/appwrite/enums/project_service_id.rb

@@ -19,6 +19,7 @@ module Appwrite
             MIGRATIONS = 'migrations'
             MESSAGING = 'messaging'
             ADVISOR = 'advisor'
+            OAUTH2 = 'oauth2'
         end
     end
 end

data/lib/appwrite/models/activity_event.rb

@@ -17,24 +17,21 @@ module Appwrite
             attr_reader :ip
             attr_reader :mode
             attr_reader :country
+            attr_reader :continent_code
+            attr_reader :city
+            attr_reader :subdivisions
+            attr_reader :isp
+            attr_reader :autonomous_system_number
+            attr_reader :autonomous_system_organization
+            attr_reader :connection_type
+            attr_reader :connection_usage_type
+            attr_reader :connection_organization
             attr_reader :time
             attr_reader :project_id
             attr_reader :team_id
             attr_reader :hostname
-            attr_reader :os_code
-            attr_reader :os_name
-            attr_reader :os_version
-            attr_reader :client_type
-            attr_reader :client_code
-            attr_reader :client_name
-            attr_reader :client_version
-            attr_reader :client_engine
-            attr_reader :client_engine_version
-            attr_reader :device_name
-            attr_reader :device_brand
-            attr_reader :device_model
-            attr_reader :country_code
-            attr_reader :country_name
+            attr_reader :sdk
+            attr_reader :sdk_version
 
             def initialize(
                 id:,
@@ -51,24 +48,21 @@ module Appwrite
                 ip:,
                 mode:,
                 country:,
+                continent_code:,
+                city:,
+                subdivisions:,
+                isp:,
+                autonomous_system_number:,
+                autonomous_system_organization:,
+                connection_type:,
+                connection_usage_type:,
+                connection_organization:,
                 time:,
                 project_id:,
                 team_id:,
                 hostname:,
-                os_code:,
-                os_name:,
-                os_version:,
-                client_type:,
-                client_code:,
-                client_name:,
-                client_version:,
-                client_engine:,
-                client_engine_version:,
-                device_name:,
-                device_brand:,
-                device_model:,
-                country_code:,
-                country_name:
+                sdk:,
+                sdk_version:
             )
                 @id = id
                 @actor_type = actor_type
@@ -84,24 +78,21 @@ module Appwrite
                 @ip = ip
                 @mode = mode
                 @country = country
+                @continent_code = continent_code
+                @city = city
+                @subdivisions = subdivisions
+                @isp = isp
+                @autonomous_system_number = autonomous_system_number
+                @autonomous_system_organization = autonomous_system_organization
+                @connection_type = connection_type
+                @connection_usage_type = connection_usage_type
+                @connection_organization = connection_organization
                 @time = time
                 @project_id = project_id
                 @team_id = team_id
                 @hostname = hostname
-                @os_code = os_code
-                @os_name = os_name
-                @os_version = os_version
-                @client_type = client_type
-                @client_code = client_code
-                @client_name = client_name
-                @client_version = client_version
-                @client_engine = client_engine
-                @client_engine_version = client_engine_version
-                @device_name = device_name
-                @device_brand = device_brand
-                @device_model = device_model
-                @country_code = country_code
-                @country_name = country_name
+                @sdk = sdk
+                @sdk_version = sdk_version
             end
 
             def self.from(map:)
@@ -120,24 +111,21 @@ module Appwrite
                     ip: map["ip"],
                     mode: map["mode"],
                     country: map["country"],
+                    continent_code: map["continentCode"],
+                    city: map["city"],
+                    subdivisions: map["subdivisions"],
+                    isp: map["isp"],
+                    autonomous_system_number: map["autonomousSystemNumber"],
+                    autonomous_system_organization: map["autonomousSystemOrganization"],
+                    connection_type: map["connectionType"],
+                    connection_usage_type: map["connectionUsageType"],
+                    connection_organization: map["connectionOrganization"],
                     time: map["time"],
                     project_id: map["projectId"],
                     team_id: map["teamId"],
                     hostname: map["hostname"],
-                    os_code: map["osCode"],
-                    os_name: map["osName"],
-                    os_version: map["osVersion"],
-                    client_type: map["clientType"],
-                    client_code: map["clientCode"],
-                    client_name: map["clientName"],
-                    client_version: map["clientVersion"],
-                    client_engine: map["clientEngine"],
-                    client_engine_version: map["clientEngineVersion"],
-                    device_name: map["deviceName"],
-                    device_brand: map["deviceBrand"],
-                    device_model: map["deviceModel"],
-                    country_code: map["countryCode"],
-                    country_name: map["countryName"]
+                    sdk: map["sdk"],
+                    sdk_version: map["sdkVersion"]
                 )
             end
 
@@ -157,24 +145,21 @@ module Appwrite
                     "ip": @ip,
                     "mode": @mode,
                     "country": @country,
+                    "continentCode": @continent_code,
+                    "city": @city,
+                    "subdivisions": @subdivisions,
+                    "isp": @isp,
+                    "autonomousSystemNumber": @autonomous_system_number,
+                    "autonomousSystemOrganization": @autonomous_system_organization,
+                    "connectionType": @connection_type,
+                    "connectionUsageType": @connection_usage_type,
+                    "connectionOrganization": @connection_organization,
                     "time": @time,
                     "projectId": @project_id,
                     "teamId": @team_id,
                     "hostname": @hostname,
-                    "osCode": @os_code,
-                    "osName": @os_name,
-                    "osVersion": @os_version,
-                    "clientType": @client_type,
-                    "clientCode": @client_code,
-                    "clientName": @client_name,
-                    "clientVersion": @client_version,
-                    "clientEngine": @client_engine,
-                    "clientEngineVersion": @client_engine_version,
-                    "deviceName": @device_name,
-                    "deviceBrand": @device_brand,
-                    "deviceModel": @device_model,
-                    "countryCode": @country_code,
-                    "countryName": @country_name
+                    "sdk": @sdk,
+                    "sdkVersion": @sdk_version
                 }
             end
         end

data/lib/appwrite/models/additional_resource.rb

@@ -0,0 +1,52 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class AdditionalResource
+            attr_reader :name
+            attr_reader :unit
+            attr_reader :currency
+            attr_reader :price
+            attr_reader :value
+            attr_reader :invoice_desc
+
+            def initialize(
+                name:,
+                unit:,
+                currency:,
+                price:,
+                value:,
+                invoice_desc:
+            )
+                @name = name
+                @unit = unit
+                @currency = currency
+                @price = price
+                @value = value
+                @invoice_desc = invoice_desc
+            end
+
+            def self.from(map:)
+                AdditionalResource.new(
+                    name: map["name"],
+                    unit: map["unit"],
+                    currency: map["currency"],
+                    price: map["price"],
+                    value: map["value"],
+                    invoice_desc: map["invoiceDesc"]
+                )
+            end
+
+            def to_map
+                {
+                    "name": @name,
+                    "unit": @unit,
+                    "currency": @currency,
+                    "price": @price,
+                    "value": @value,
+                    "invoiceDesc": @invoice_desc
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/app.rb

@@ -0,0 +1,152 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class App
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :name
+            attr_reader :description
+            attr_reader :client_uri
+            attr_reader :logo_uri
+            attr_reader :privacy_policy_url
+            attr_reader :terms_url
+            attr_reader :contacts
+            attr_reader :tagline
+            attr_reader :tags
+            attr_reader :labels
+            attr_reader :images
+            attr_reader :support_url
+            attr_reader :data_deletion_url
+            attr_reader :redirect_uris
+            attr_reader :post_logout_redirect_uris
+            attr_reader :enabled
+            attr_reader :type
+            attr_reader :device_flow
+            attr_reader :team_id
+            attr_reader :user_id
+            attr_reader :installation_scopes
+            attr_reader :installation_redirect_url
+            attr_reader :secrets
+
+            def initialize(
+                id:,
+                created_at:,
+                updated_at:,
+                name:,
+                description:,
+                client_uri:,
+                logo_uri:,
+                privacy_policy_url:,
+                terms_url:,
+                contacts:,
+                tagline:,
+                tags:,
+                labels:,
+                images:,
+                support_url:,
+                data_deletion_url:,
+                redirect_uris:,
+                post_logout_redirect_uris:,
+                enabled:,
+                type:,
+                device_flow:,
+                team_id:,
+                user_id:,
+                installation_scopes:,
+                installation_redirect_url:,
+                secrets:
+            )
+                @id = id
+                @created_at = created_at
+                @updated_at = updated_at
+                @name = name
+                @description = description
+                @client_uri = client_uri
+                @logo_uri = logo_uri
+                @privacy_policy_url = privacy_policy_url
+                @terms_url = terms_url
+                @contacts = contacts
+                @tagline = tagline
+                @tags = tags
+                @labels = labels
+                @images = images
+                @support_url = support_url
+                @data_deletion_url = data_deletion_url
+                @redirect_uris = redirect_uris
+                @post_logout_redirect_uris = post_logout_redirect_uris
+                @enabled = enabled
+                @type = type
+                @device_flow = device_flow
+                @team_id = team_id
+                @user_id = user_id
+                @installation_scopes = installation_scopes
+                @installation_redirect_url = installation_redirect_url
+                @secrets = secrets
+            end
+
+            def self.from(map:)
+                App.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    name: map["name"],
+                    description: map["description"],
+                    client_uri: map["clientUri"],
+                    logo_uri: map["logoUri"],
+                    privacy_policy_url: map["privacyPolicyUrl"],
+                    terms_url: map["termsUrl"],
+                    contacts: map["contacts"],
+                    tagline: map["tagline"],
+                    tags: map["tags"],
+                    labels: map["labels"],
+                    images: map["images"],
+                    support_url: map["supportUrl"],
+                    data_deletion_url: map["dataDeletionUrl"],
+                    redirect_uris: map["redirectUris"],
+                    post_logout_redirect_uris: map["postLogoutRedirectUris"],
+                    enabled: map["enabled"],
+                    type: map["type"],
+                    device_flow: map["deviceFlow"],
+                    team_id: map["teamId"],
+                    user_id: map["userId"],
+                    installation_scopes: map["installationScopes"],
+                    installation_redirect_url: map["installationRedirectUrl"],
+                    secrets: map["secrets"].map { |it| AppSecret.from(map: it) }
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
+                    "name": @name,
+                    "description": @description,
+                    "clientUri": @client_uri,
+                    "logoUri": @logo_uri,
+                    "privacyPolicyUrl": @privacy_policy_url,
+                    "termsUrl": @terms_url,
+                    "contacts": @contacts,
+                    "tagline": @tagline,
+                    "tags": @tags,
+                    "labels": @labels,
+                    "images": @images,
+                    "supportUrl": @support_url,
+                    "dataDeletionUrl": @data_deletion_url,
+                    "redirectUris": @redirect_uris,
+                    "postLogoutRedirectUris": @post_logout_redirect_uris,
+                    "enabled": @enabled,
+                    "type": @type,
+                    "deviceFlow": @device_flow,
+                    "teamId": @team_id,
+                    "userId": @user_id,
+                    "installationScopes": @installation_scopes,
+                    "installationRedirectUrl": @installation_redirect_url,
+                    "secrets": @secrets.map { |it| it.to_map }
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/app_installation.rb

@@ -0,0 +1,72 @@
+#frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class AppInstallation
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :app_id
+            attr_reader :team_id
+            attr_reader :scopes
+            attr_reader :authorization_details
+            attr_reader :created_by_id
+            attr_reader :created_by_name
+            attr_reader :last_accessed_at
+
+            def initialize(
+                id:,
+                created_at:,
+                updated_at:,
+                app_id:,
+                team_id:,
+                scopes:,
+                authorization_details:,
+                created_by_id:,
+                created_by_name:,
+                last_accessed_at: 
+            )
+                @id = id
+                @created_at = created_at
+                @updated_at = updated_at
+                @app_id = app_id
+                @team_id = team_id
+                @scopes = scopes
+                @authorization_details = authorization_details
+                @created_by_id = created_by_id
+                @created_by_name = created_by_name
+                @last_accessed_at = last_accessed_at
+            end
+
+            def self.from(map:)
+                AppInstallation.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    app_id: map["appId"],
+                    team_id: map["teamId"],
+                    scopes: map["scopes"],
+                    authorization_details: map["authorizationDetails"],
+                    created_by_id: map["createdById"],
+                    created_by_name: map["createdByName"],
+                    last_accessed_at: map["lastAccessedAt"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
+                    "appId": @app_id,
+                    "teamId": @team_id,
+                    "scopes": @scopes,
+                    "authorizationDetails": @authorization_details,
+                    "createdById": @created_by_id,
+                    "createdByName": @created_by_name,
+                    "lastAccessedAt": @last_accessed_at
+                }
+            end
+        end
+    end
+end