appwrite 26.0.0 → 27.0.0

data/lib/appwrite/services/backups.rb

@@ -317,24 +317,44 @@ module Appwrite
 
         # Create and trigger a new restoration for a backup on a project.
         # 
-        # When restoring a DocumentsDB or VectorsDB database to a new resource, pass
-        # `newSpecification` to provision the restored database on a different
-        # specification than the archived one (for example, restoring onto a larger
-        # or smaller dedicated database). Use `serverless` to restore onto the shared
-        # pool, or a dedicated specification slug to restore onto a dedicated
-        # database of that size. The specification must be permitted by the
-        # organization's plan. `newSpecification` is not supported for
-        # legacy/TablesDB databases or for bucket restores.
+        # For a backup of one database, the restoration resolves its destination
+        # 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
+        # `destinationResourceType`. Database types are stored canonically as
+        # `database`, `documentsdb`, or `vectorsdb`. Project-wide restorations leave
+        # these fields empty because they do not have a single source or destination
+        # database.
+        # 
+        # To list every migration related to one database, use its canonical type in
+        # a nested `OR(AND(...), AND(...), AND(...))` across the root, parent, and
+        # destination relation pairs: `(resourceType, resourceId)`,
+        # `(parentResourceType, parentResourceId)`, and `(destinationResourceType,
+        # destinationResourceId)`. Legacy and TablesDB databases use `database`; the
+        # operational `resourceType` of a table migration is not rewritten to
+        # `tablesdb`.
+        # 
+        # 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 Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
-        # @param [String] new_specification Specification to provision the restored database on, when restoring a DocumentsDB or VectorsDB database to a new resource. Defaults to the archived database's specification. Use `serverless` for the shared pool or a dedicated specification slug.
         #
         # @return [BackupRestoration]
-        def create_restoration(archive_id:, services:, new_resource_id: nil, new_resource_name: nil, new_specification: nil)
+        def create_restoration(archive_id:, services:, new_resource_id: nil, new_resource_name: nil)
             api_path = '/backups/restoration'
 
             if archive_id.nil?
@@ -350,7 +370,6 @@ module Appwrite
                 services: services,
                 newResourceId: new_resource_id,
                 newResourceName: new_resource_name,
-                newSpecification: new_specification,
             }
             
             api_headers = {

data/lib/appwrite/services/databases.rb

@@ -453,7 +453,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 [] document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
         # @param [] enabled Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
-        # @param [Array] attributes Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, integer, float, boolean, datetime), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
+        # @param [Array] attributes Array of attribute definitions to create. Each attribute 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 attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
         #
         # @return [Collection]
@@ -2275,11 +2275,11 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID.
         # @param [String] related_collection_id Related Collection 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 Attribute Key.
         # @param [String] two_way_key Two Way Attribute Key.
-        # @param [RelationMutate] on_delete Constraints option
+        # @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
         #
         # @return [AttributeRelationship]
         def create_relationship_attribute(database_id:, collection_id:, related_collection_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil)
@@ -2338,7 +2338,7 @@ module Appwrite
         # @param [String] database_id Database ID.
         # @param [String] collection_id Collection ID.
         # @param [String] key Attribute Key.
-        # @param [RelationMutate] on_delete Constraints option
+        # @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
         # @param [String] new_key New Attribute Key.
         #
         # @return [AttributeRelationship]

data/lib/appwrite/services/embeddings.rb

@@ -0,0 +1,48 @@
+#frozen_string_literal: true
+
+module Appwrite
+    class Embeddings < Service
+
+        def initialize(client)
+            @client = client
+        end
+
+        # Generate vector embeddings for an array of text using the selected
+        # embedding model. Use the returned vectors to power semantic search and
+        # similarity queries against your vector collections.
+        # 
+        #
+        # @param [Array] texts Array of text to generate embeddings.
+        # @param [EmbeddingModel] model The embedding model to use for generating vector embeddings.
+        #
+        # @return [EmbeddingList]
+        def create_text_embeddings(texts:, model: nil)
+            api_path = '/embeddings/text'
+
+            if texts.nil?
+              raise Appwrite::Exception.new('Missing required parameter: "texts"')
+            end
+
+            api_params = {
+                texts: texts,
+                model: model,
+            }
+            
+            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::EmbeddingList
+            )
+
+        end
+
+    end 
+end

data/lib/appwrite/services/functions.rb

@@ -151,7 +151,7 @@ module Appwrite
 
         # List allowed function specifications for this instance.
         #
-        # @param [String] type Specification type to list. Can be one of: runtimes, builds.
+        # @param [String] type Specification type to list. Can be one of: runtimes, builds. Defaults to runtimes.
         #
         # @return [SpecificationList]
         def list_specifications(type: nil)