appwrite 26.0.0 → 27.0.0

data/lib/appwrite/services/tables_db.rb

@@ -46,9 +46,11 @@ module Appwrite
         # @param [String] name Database name. Max length: 128 chars.
         # @param [] enabled Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
         # @param [String] specification Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
+        # @param [Integer] replicas Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.
+        # @param [String] sync_mode Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
         #
         # @return [Database]
-        def create(database_id:, name:, enabled: nil, specification: nil)
+        def create(database_id:, name:, enabled: nil, specification: nil, replicas: nil, sync_mode: nil)
             api_path = '/tablesdb'
 
             if database_id.nil?
@@ -64,6 +66,8 @@ module Appwrite
                 name: name,
                 enabled: enabled,
                 specification: specification,
+                replicas: replicas,
+                syncMode: sync_mode,
             }
             
             api_headers = {
@@ -82,6 +86,33 @@ module Appwrite
 
         end
 
+        # List the dedicated database specifications available on the current plan.
+        # Each specification reports its resource limits, pricing, and whether it is
+        # enabled for the organization.
+        #
+        #
+        # @return [DedicatedDatabaseSpecificationList]
+        def list_specifications()
+            api_path = '/tablesdb/specifications'
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::DedicatedDatabaseSpecificationList
+            )
+
+        end
+
         # List transactions across all databases.
         #
         # @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).
@@ -305,9 +336,12 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] name Database name. Max length: 128 chars.
         # @param [] enabled Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
+        # @param [String] specification Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
+        # @param [Integer] replicas Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
+        # @param [String] sync_mode Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
         #
         # @return [Database]
-        def update(database_id:, name: nil, enabled: nil)
+        def update(database_id:, name: nil, enabled: nil, specification: nil, replicas: nil, sync_mode: nil)
             api_path = '/tablesdb/{databaseId}'
                 .gsub('{databaseId}', database_id)
 
@@ -318,6 +352,9 @@ module Appwrite
             api_params = {
                 name: name,
                 enabled: enabled,
+                specification: specification,
+                replicas: replicas,
+                syncMode: sync_mode,
             }
             
             api_headers = {
@@ -367,6 +404,341 @@ module Appwrite
 
         end
 
+        # Trigger a manual failover for a dedicated database with high availability
+        # enabled. Promotes a replica to primary. The failover runs asynchronously;
+        # poll the database document for status updates. A database left
+        # mid-operation by a failover that did not finish also accepts this call as a
+        # repair, provided `targetReplicaId` names the member to promote.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] target_replica_id Target replica ID to promote. If not specified, the healthiest replica is selected.
+        #
+        # @return [DedicatedDatabase]
+        def create_failover(database_id:, target_replica_id: nil)
+            api_path = '/tablesdb/{databaseId}/failovers'
+                .gsub('{databaseId}', database_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            api_params = {
+                targetReplicaId: target_replica_id,
+            }
+            
+            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::DedicatedDatabase
+            )
+
+        end
+
+        # List the dedicated migrations for a TablesDB database. A database has at
+        # most one in-flight migration.
+        #
+        # @param [String] database_id Database ID.
+        #
+        # @return [DatabaseMigrationList]
+        def list_migrations(database_id:)
+            api_path = '/tablesdb/{databaseId}/migrations'
+                .gsub('{databaseId}', database_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::DatabaseMigrationList
+            )
+
+        end
+
+        # Start migrating a serverless TablesDB database onto a dedicated MySQL
+        # compute. Data is copied to the target while the source stays live, with a
+        # brief read-only window during cutover.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] specification Dedicated compute specification to provision as the migration target (e.g. s-2vcpu-4gb). The migration always targets a dedicated compute, so `serverless` is not accepted.
+        # @param [] auto_cutover Whether to cut over automatically once the copy is verified. When disabled the migration parks at ready_to_cutover and holds there until the cutover is performed manually.
+        #
+        # @return [DatabaseMigration]
+        def create_migration(database_id:, specification:, auto_cutover: nil)
+            api_path = '/tablesdb/{databaseId}/migrations'
+                .gsub('{databaseId}', database_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if specification.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "specification"')
+            end
+
+            api_params = {
+                specification: specification,
+                autoCutover: auto_cutover,
+            }
+            
+            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::DatabaseMigration
+            )
+
+        end
+
+        # Get a single dedicated migration for a TablesDB database by its ID.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] migration_id Migration ID.
+        #
+        # @return [DatabaseMigration]
+        def get_migration(database_id:, migration_id:)
+            api_path = '/tablesdb/{databaseId}/migrations/{migrationId}'
+                .gsub('{databaseId}', database_id)
+                .gsub('{migrationId}', migration_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if migration_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "migrationId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::DatabaseMigration
+            )
+
+        end
+
+        # Abort an in-flight TablesDB dedicated migration. Only allowed before
+        # cutover; once the migration has cut over it cannot be aborted.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] migration_id Migration ID.
+        #
+        # @return []
+        def delete_migration(database_id:, migration_id:)
+            api_path = '/tablesdb/{databaseId}/migrations/{migrationId}'
+                .gsub('{databaseId}', database_id)
+                .gsub('{migrationId}', migration_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if migration_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "migrationId"')
+            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
+
+        # Cut a verified TablesDB migration over to its dedicated compute. Only
+        # applies to a migration created with `autoCutover` disabled, which waits at
+        # `ready_to_cutover` until this is called. The routing flip happens shortly
+        # after this returns, with a brief read-only window. One call buys one
+        # attempt: a cutover that fails a check returns the migration to `verifying`
+        # and parks it again, so call this once more to retry.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] migration_id Migration ID.
+        #
+        # @return [DatabaseMigration]
+        def cutover_migration(database_id:, migration_id:)
+            api_path = '/tablesdb/{databaseId}/migrations/{migrationId}/cutover'
+                .gsub('{databaseId}', database_id)
+                .gsub('{migrationId}', migration_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            if migration_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "migrationId"')
+            end
+
+            api_params = {
+            }
+            
+            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::DatabaseMigration
+            )
+
+        end
+
+        # List the lifecycle operations recorded for a dedicated database, newest
+        # first. Every provision, update, restore, backup and replication action is
+        # recorded here with its outcome, including an attempt that was abandoned
+        # because another worker took over the database.
+        #
+        # @param [String] database_id Database ID.
+        # @param [String] status Filter by operation status.
+        # @param [Integer] limit Maximum number of operations to return.
+        # @param [Integer] offset Number of operations to skip.
+        #
+        # @return [DedicatedDatabaseOperationList]
+        def list_operations(database_id:, status: nil, limit: nil, offset: nil)
+            api_path = '/tablesdb/{databaseId}/operations'
+                .gsub('{databaseId}', database_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            api_params = {
+                status: status,
+                limit: limit,
+                offset: offset,
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::DedicatedDatabaseOperationList
+            )
+
+        end
+
+        # Get high availability status for a dedicated database. Returns replica
+        # statuses, replication lag, and sync mode.
+        #
+        # @param [String] database_id Database ID.
+        #
+        # @return [DedicatedDatabaseReplicas]
+        def get_replicas(database_id:)
+            api_path = '/tablesdb/{databaseId}/replicas'
+                .gsub('{databaseId}', database_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::DedicatedDatabaseReplicas
+            )
+
+        end
+
+        # Get real-time health and status information for a dedicated database.
+        # Returns health status, readiness, uptime, connection info, replica status,
+        # and volume information.
+        #
+        # @param [String] database_id Database ID.
+        #
+        # @return [DatabaseStatus]
+        def get_status(database_id:)
+            api_path = '/tablesdb/{databaseId}/status'
+                .gsub('{databaseId}', database_id)
+
+            if database_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
+            end
+
+            api_params = {
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::DatabaseStatus
+            )
+
+        end
+
         # Get a list of all tables that belong to the provided databaseId. You can
         # use the search parameter to filter your results.
         #
@@ -416,7 +788,7 @@ module Appwrite
         # @param [Array] permissions An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
         # @param [] row_security Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
         # @param [] enabled Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
-        # @param [Array] columns Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
+        # @param [Array] columns Array of column definitions to create. Each column should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
         # @param [Array] indexes Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
         #
         # @return [Table]
@@ -2144,11 +2516,11 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] table_id Table ID.
         # @param [String] related_table_id Related Table ID.
-        # @param [RelationshipType] type Relation type
+        # @param [RelationshipType] type Relationship type. Possible values are: oneToOne, oneToMany, manyToOne, manyToMany.
         # @param [] two_way Is Two Way?
         # @param [String] key Column Key.
         # @param [String] two_way_key Two Way Column Key.
-        # @param [RelationMutate] on_delete Constraints option
+        # @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
         #
         # @return [ColumnRelationship]
         def create_relationship_column(database_id:, table_id:, related_table_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil)
@@ -2832,7 +3204,7 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] table_id Table ID.
         # @param [String] key Column Key.
-        # @param [RelationMutate] on_delete Constraints option
+        # @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
         # @param [String] new_key New Column Key.
         #
         # @return [ColumnRelationship]

data/lib/appwrite/services/teams.rb

@@ -181,6 +181,204 @@ module Appwrite
 
         end
 
+        # List app installations on a team. Any team member can read installations.
+        #
+        # @param [String] team_id Team 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.
+        # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
+        #
+        # @return [AppInstallationList]
+        def list_installations(team_id:, queries: nil, total: nil)
+            api_path = '/teams/{teamId}/installations'
+                .gsub('{teamId}', team_id)
+
+            if team_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "teamId"')
+            end
+
+            api_params = {
+                queries: queries,
+                total: total,
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AppInstallationList
+            )
+
+        end
+
+        # Install an app on a team. When authenticated as a user, only team members
+        # with the owner role can install apps. Requests using an API key or in admin
+        # mode can install apps on any team. The installation is granted the scopes
+        # the app currently requests.
+        #
+        # @param [String] team_id Team ID.
+        # @param [String] app_id Application unique ID.
+        # @param [String] authorization_details Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.
+        #
+        # @return [AppInstallation]
+        def create_installation(team_id:, app_id:, authorization_details: nil)
+            api_path = '/teams/{teamId}/installations'
+                .gsub('{teamId}', team_id)
+
+            if team_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "teamId"')
+            end
+
+            if app_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "appId"')
+            end
+
+            api_params = {
+                appId: app_id,
+                authorizationDetails: authorization_details,
+            }
+            
+            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::AppInstallation
+            )
+
+        end
+
+        # Get an app installation on a team by its unique ID. Any team member can
+        # read installations.
+        #
+        # @param [String] team_id Team ID.
+        # @param [String] installation_id Installation unique ID.
+        #
+        # @return [AppInstallation]
+        def get_installation(team_id:, installation_id:)
+            api_path = '/teams/{teamId}/installations/{installationId}'
+                .gsub('{teamId}', team_id)
+                .gsub('{installationId}', installation_id)
+
+            if team_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "teamId"')
+            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'),
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'GET',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AppInstallation
+            )
+
+        end
+
+        # Update an app installation on a team. Only team members with the owner role
+        # can update installations. The installation's granted scopes are refreshed
+        # to the scopes the app currently requests; previously issued installation
+        # access tokens are revoked.
+        #
+        # @param [String] team_id Team ID.
+        # @param [String] installation_id Installation unique ID.
+        # @param [String] authorization_details Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.
+        #
+        # @return [AppInstallation]
+        def update_installation(team_id:, installation_id:, authorization_details: nil)
+            api_path = '/teams/{teamId}/installations/{installationId}'
+                .gsub('{teamId}', team_id)
+                .gsub('{installationId}', installation_id)
+
+            if team_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "teamId"')
+            end
+
+            if installation_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+            end
+
+            api_params = {
+                authorizationDetails: authorization_details,
+            }
+            
+            api_headers = {
+                "X-Appwrite-Project": @client.get_config('project'),
+                "content-type": 'application/json',
+                "accept": 'application/json',
+            }
+
+            @client.call(
+                method: 'PUT',
+                path: api_path,
+                headers: api_headers,
+                params: api_params,
+                response_type: Models::AppInstallation
+            )
+
+        end
+
+        # Uninstall an app from a team by its installation ID. Only team members with
+        # the owner role can remove installations. Previously issued installation
+        # access tokens are revoked.
+        #
+        # @param [String] team_id Team ID.
+        # @param [String] installation_id Installation unique ID.
+        #
+        # @return []
+        def delete_installation(team_id:, installation_id:)
+            api_path = '/teams/{teamId}/installations/{installationId}'
+                .gsub('{teamId}', team_id)
+                .gsub('{installationId}', installation_id)
+
+            if team_id.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "teamId"')
+            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
+
         # Use this endpoint to list a team's members using the team's ID. All team
         # members have read access to this endpoint. Hide sensitive attributes from
         # the response by toggling membership privacy in the Console.