arangojs 7.8.0 → 8.0.0

package/collection.d.ts

@@ -12,11 +12,12 @@
  *
  * @packageDocumentation
  */
-import { ArangoResponseMetadata, Dict } from "./connection";
+import { AqlLiteral, AqlQuery } from "./aql";
+import { ArangoApiResponse } from "./connection";
 import { ArrayCursor } from "./cursor";
 import { Database } from "./database";
 import { Document, DocumentData, DocumentMetadata, DocumentSelector, Edge, EdgeData, ObjectWithKey, Patch } from "./documents";
-import { EnsureFulltextIndexOptions, EnsureGeoIndexOptions, EnsureHashIndexOptions, EnsurePersistentIndexOptions, EnsureSkiplistIndexOptions, EnsureTtlIndexOptions, EnsureZkdIndexOptions, FulltextIndex, GeoIndex, HashIndex, Index, IndexSelector, PersistentIndex, SkiplistIndex, TtlIndex, ZkdIndex } from "./indexes";
+import { EnsureFulltextIndexOptions, EnsureGeoIndexOptions, EnsureInvertedIndexOptions, EnsurePersistentIndexOptions, EnsureTtlIndexOptions, EnsureZkdIndexOptions, FulltextIndex, GeoIndex, Index, IndexSelector, InvertedIndex, PersistentIndex, TtlIndex, ZkdIndex } from "./indexes";
 import { Blob } from "./lib/blob";
 /**
  * Indicates whether the given value represents an {@link ArangoCollection}.
@@ -35,7 +36,7 @@ export declare function collectionToString(collection: string | ArangoCollection
  * A marker interface identifying objects that can be used in AQL template
  * strings to create references to ArangoDB collections.
  *
- * See {@link aql}.
+ * See {@link aql!aql}.
  */
 export interface ArangoCollection {
     /**
@@ -74,11 +75,11 @@ export declare type KeyGenerator = "traditional" | "autoincrement" | "uuid" | "p
 /**
  * Strategy for sharding a collection.
  */
-export declare type ShardingStrategy = "hash" | "enterprise-hash-smart-edge" | "community-compat" | "enterprise-compat" | "enterprise-smart-edge-compat";
+export declare type ShardingStrategy = "hash" | "enterprise-hash-smart-edge" | "enterprise-hash-smart-vertex" | "community-compat" | "enterprise-compat" | "enterprise-smart-edge-compat";
 /**
  * Type of document reference.
  *
- * See {@link DocumentCollection.list} and {@link EdgeCollection.list}.
+ * See {@link DocumentCollection#list} and {@link EdgeCollection#list}.
  *
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
@@ -94,6 +95,43 @@ export declare type SimpleQueryListType = "id" | "key" | "path";
  * * `"strict"`: New and modified documents are always validated.
  */
 export declare type ValidationLevel = "none" | "new" | "moderate" | "strict";
+/**
+ * Write operation that can result in a computed value being computed.
+ */
+export declare type WriteOperation = "insert" | "update" | "replace";
+/**
+ * Properties defining a computed value.
+ */
+export declare type ComputedValueProperties = {
+    /**
+     * Name of the target attribute of the computed value.
+     */
+    name: string;
+    /**
+     * AQL `RETURN` expression that computes the value.
+     */
+    expression: string;
+    /**
+     * If set to `false`, the computed value will not be applied if the
+     * expression evaluates to `null`.
+     */
+    overwrite: boolean;
+    /**
+     * Which operations should result in the value being computed.
+     */
+    computeOn: WriteOperation[];
+    /**
+     * If set to `false`, the field will be unset if the expression evaluates to
+     * `null`. Otherwise the field will be set to the value `null`. Has no effect
+     * if `overwrite` is set to `false`.
+     */
+    keepNull: boolean;
+    /**
+     * Whether the write operation should fail if the expression produces a
+     * warning.
+     */
+    failOnWarning: boolean;
+};
 /**
  * General information about a collection.
  */
@@ -192,12 +230,6 @@ export declare type CollectionProperties = {
      * (Cluster only.) Write concern for this collection.
      */
     writeConcern: number;
-    /**
-     * (Cluster only.) Write concern for this collection.
-     *
-     * @deprecated Renamed to `writeConcern` in ArangoDB 3.6.
-     */
-    minReplicationFactor?: number;
     /**
      * (Cluster only.) Number of shards of this collection.
      */
@@ -210,48 +242,90 @@ export declare type CollectionProperties = {
     /**
      * (Cluster only.) Replication factor of the collection.
      */
-    replicationFactor?: number;
+    replicationFactor?: number | "satellite";
     /**
      * (Cluster only.) Sharding strategy of the collection.
      */
     shardingStrategy?: ShardingStrategy;
     /**
-     * (MMFiles only.) Whether the collection will be compacted.
-     *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * (Enterprise Edition cluster only.) If set to a collection name, sharding
+     * of the new collection will follow the rules for that collection. As long
+     * as the new collection exists, the indicated collection can not be dropped.
+     */
+    distributeShardsLike?: string;
+    /**
+     * (Enterprise Edition cluster only.) Attribute containing the shard key
+     * value of the referred-to smart join collection.
      */
-    doCompact?: boolean;
+    smartJoinAttribute?: string;
     /**
-     * (MMFiles only.) Maximum size for each journal or datafile in bytes.
+     * (Enterprise Edition cluster only.) Attribute used for sharding.
+     */
+    smartGraphAttribute?: string;
+    /**
+     * Computed values applied to documents in this collection.
+     */
+    computedValues: ComputedValueProperties[];
+    /**
+     * Whether the in-memory hash cache is enabled for this collection.
+     */
+    cacheEnabled: boolean;
+    /**
+     * Whether the newer revision-based replication protocol is enabled for
+     * this collection.
+     */
+    syncByRevision: boolean;
+    /**
+     * (Enterprise Edition only.) Whether the collection is used in a SmartGraph or EnterpriseGraph.
+     */
+    isSmart?: boolean;
+    /**
+     * (Enterprise Edition only.) Whether the SmartGraph this collection belongs to is disjoint.
+     */
+    isDisjoint?: string;
+};
+/**
+ * Options for creating a computed value.
+ */
+export declare type ComputedValueOptions = {
+    /**
+     * Name of the target attribute of the computed value.
+     */
+    name: string;
+    /**
+     * AQL `RETURN` expression that computes the value.
      *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * Note that when passing an AQL query object, the `bindVars` will be ignored.
      */
-    journalSize?: number;
+    expression: string | AqlLiteral | AqlQuery;
     /**
-     * (MMFiles only.) Number of buckets into which indexes using hash tables are
-     * split.
+     * If set to `false`, the computed value will not be applied if the
+     * expression evaluates to `null`.
      *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * Default: `true`
      */
-    indexBuckets?: number;
+    overwrite?: boolean;
     /**
-     * (MMFiles only.) If set to `true`, the collection will only be kept
-     * in-memory and discarded when unloaded, resulting in full data loss.
+     * Which operations should result in the value being computed.
      *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * Default: `["insert", "update", "replace"]`
      */
-    isVolatile?: boolean;
+    computeOn?: WriteOperation[];
     /**
-     * (Enterprise Edition cluster only.) If set to a collection name, sharding
-     * of the new collection will follow the rules for that collection. As long
-     * as the new collection exists, the indicated collection can not be dropped.
+     * If set to `false`, the field will be unset if the expression evaluates to
+     * `null`. Otherwise the field will be set to the value `null`. Has no effect
+     * if `overwrite` is set to `false`.
+     *
+     * Default: `true`
      */
-    distributeShardsLike?: string;
+    keepNull?: boolean;
     /**
-     * (Enterprise Edition cluster only.) Attribute containing the shard key
-     * value of the referred-to smart join collection.
+     * Whether the write operation should fail if the expression produces a
+     * warning.
+     *
+     * Default: `false`
      */
-    smartJoinAttribute?: string;
+    failOnWarning?: boolean;
 };
 /**
  * Options for validating collection documents.
@@ -275,7 +349,7 @@ export declare type SchemaOptions = {
 /**
  * Options for setting a collection's properties.
  *
- * See {@link DocumentCollection.properties} and {@link EdgeCollection.properties}.
+ * See {@link DocumentCollection#properties} and {@link EdgeCollection#properties}.
  */
 export declare type CollectionPropertiesOptions = {
     /**
@@ -283,18 +357,31 @@ export declare type CollectionPropertiesOptions = {
      * a document create, update, replace or removal operation.
      */
     waitForSync?: boolean;
+    /**
+     * (Cluster only.) How many copies of each document should be kept in the
+     * cluster.
+     *
+     * Default: `1`
+     */
+    replicationFactor?: number | "satellite";
+    /**
+     * (Cluster only.) Write concern for this collection.
+     */
+    writeConcern?: number;
     /**
      * Options for validating documents in this collection.
      */
     schema?: SchemaOptions;
     /**
-     * (MMFiles only.) Maximum size for each journal or datafile in bytes.
-     *
-     * Must be a number greater than or equal to `1048576` (1 MiB).
+     * Computed values to apply to documents in this collection.
+     */
+    computedValues?: ComputedValueOptions[];
+    /**
+     * Whether the in-memory hash cache is enabled for this collection.
      *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * Default: `false`
      */
-    journalSize?: number;
+    cacheEnabled?: boolean;
 };
 /**
  * Options for retrieving a collection checksum.
@@ -355,8 +442,8 @@ export declare type CollectionKeyOptions = {
 /**
  * Options for creating a collection.
  *
- * See {@link Database.createCollection}, {@link Database.createEdgeCollection}
- * and {@link DocumentCollection.create} or {@link EdgeCollection.create}.
+ * See {@link database.Database#createCollection}, {@link database.Database#createEdgeCollection}
+ * and {@link DocumentCollection#create} or {@link EdgeCollection#create}.
  */
 export declare type CreateCollectionOptions = {
     /**
@@ -420,63 +507,48 @@ export declare type CreateCollectionOptions = {
      * (Cluster only.) Write concern for this collection.
      */
     writeConcern?: number;
-    /**
-     * (Cluster only.) Write concern for this collection.
-     *
-     * @deprecated Renamed to `writeConcern` in ArangoDB 3.6.
-     */
-    minReplicationFactor?: number;
     /**
      * (Cluster only.) Sharding strategy to use.
      */
     shardingStrategy?: ShardingStrategy;
     /**
-     * (MMFiles only.) Number of buckets into which indexes using hash tables are
-     * split.
-     *
-     * Must be a power of 2 and less than or equal to `1024`.
-     *
-     * Default: `16`
-     *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * (Enterprise Edition cluster only.) If set to a collection name, sharding
+     * of the new collection will follow the rules for that collection. As long
+     * as the new collection exists, the indicated collection can not be dropped.
      */
-    indexBuckets?: number;
+    distributeShardsLike?: string;
     /**
-     * (MMFiles only.) Whether the collection will be compacted.
-     *
-     * Default: `true`
-     *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * (Enterprise Edition cluster only.) Attribute containing the shard key
+     * value of the referred-to smart join collection.
      */
-    doCompact?: boolean;
+    smartJoinAttribute?: string;
     /**
-     * (MMFiles only.) Maximum size for each journal or datafile in bytes.
-     *
-     * Must be a number greater than or equal to `1048576` (1 MiB).
-     *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * (Enterprise Edition cluster only.) Attribute used for sharding.
      */
-    journalSize?: number;
+    smartGraphAttribute?: string;
     /**
-     * (MMFiles only.) If set to `true`, the collection will only be kept
-     * in-memory and discarded when unloaded, resulting in full data loss.
-     *
-     * Default: `false`
-     *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
+     * Computed values to apply to documents in this collection.
      */
-    isVolatile?: boolean;
+    computedValues?: ComputedValueOptions[];
     /**
-     * (Enterprise Edition cluster only.) If set to a collection name, sharding
-     * of the new collection will follow the rules for that collection. As long
-     * as the new collection exists, the indicated collection can not be dropped.
+     * Whether the in-memory hash cache is enabled for this collection.
      */
-    distributeShardsLike?: string;
+    cacheEnabled?: boolean;
+};
+/**
+ * Options for checking whether a document exists in a collection.
+ */
+export declare type DocumentExistsOptions = {
     /**
-     * (Enterprise Edition cluster only.) Attribute containing the shard key
-     * value of the referred-to smart join collection.
+     * If set to a document revision, the document will only match if its `_rev`
+     * matches the given revision.
      */
-    smartJoinAttribute?: string;
+    ifMatch?: string;
+    /**
+     * If set to a document revision, the document will only match if its `_rev`
+     * does not match the given revision.
+     */
+    ifNoneMatch?: string;
 };
 /**
  * Options for retrieving a document from a collection.
@@ -493,6 +565,17 @@ export declare type CollectionReadOptions = {
      * request without distinguishing between leaders and followers.
      */
     allowDirtyRead?: boolean;
+    /**
+     * If set to a document revision, the request will fail with an error if the
+     * document exists but its `_rev` does not match the given revision.
+     */
+    ifMatch?: string;
+    /**
+     * If set to a document revision, the request will fail with an error if the
+     * document exists and its `_rev` matches the given revision. Note that an
+     * `HttpError` with code 304 will be thrown instead of an `ArangoError`.
+     */
+    ifNoneMatch?: string;
 };
 /**
  * Options for retrieving multiple documents from a collection.
@@ -529,14 +612,6 @@ export declare type CollectionInsertOptions = {
      * Default: `false`
      */
     returnNew?: boolean;
-    /**
-     * If set to `true`, a document with the same `_key` or `_id` already
-     * existing will be overwritten instead of resulting in an exception.
-     *
-     * @deprecated This option has been deprecated in ArangoDB 3.7 and replaced
-     * with the `overwriteMode` option.
-     */
-    overwrite?: boolean;
     /**
      * Defines what should happen if a document with the same `_key` or `_id`
      * already exists, instead of throwing an exception.
@@ -583,6 +658,11 @@ export declare type CollectionReplaceOptions = {
      * Default: `false`
      */
     returnOld?: boolean;
+    /**
+     * If set to a document revision, the document will only be replaced if its
+     * `_rev` matches the given revision.
+     */
+    ifMatch?: string;
 };
 /**
  * Options for updating a document in a collection.
@@ -637,6 +717,11 @@ export declare type CollectionUpdateOptions = {
      * Default: `true`
      */
     mergeObjects?: boolean;
+    /**
+     * If set to a document revision, the document will only be updated if its
+     * `_rev` matches the given revision.
+     */
+    ifMatch?: string;
 };
 /**
  * Options for removing a document from a collection.
@@ -662,6 +747,11 @@ export declare type CollectionRemoveOptions = {
      * Default: `false`
      */
     silent?: boolean;
+    /**
+     * If set to a document revision, the document will only be removed if its
+     * `_rev` matches the given revision.
+     */
+    ifMatch?: string;
 };
 /**
  * Options for bulk importing documents into a collection.
@@ -707,6 +797,17 @@ export declare type CollectionImportOptions = {
      */
     details?: boolean;
 };
+/**
+ * Options for retrieving a document's edges from a collection.
+ */
+export declare type CollectionEdgesOptions = {
+    /**
+     * If set to `true`, the request will explicitly permit ArangoDB to return a
+     * potentially dirty or stale result and arangojs will load balance the
+     * request without distinguishing between leaders and followers.
+     */
+    allowDirtyRead?: boolean;
+};
 /**
  * Options for retrieving documents by example.
  *
@@ -728,14 +829,14 @@ export declare type SimpleQueryByExampleOptions = {
      *
      * Must be greater than zero.
      *
-     * See also {@link QueryOptions}.
+     * See also {@link database.QueryOptions}.
      */
     batchSize?: number;
     /**
      * Time-to-live for the cursor in seconds. The cursor results may be
      * garbage collected by ArangoDB after this much time has passed.
      *
-     * See also {@link QueryOptions}.
+     * See also {@link database.QueryOptions}.
      */
     ttl?: number;
 };
@@ -760,20 +861,20 @@ export declare type SimpleQueryAllOptions = {
      *
      * Must be greater than zero.
      *
-     * See also {@link QueryOptions}.
+     * See also {@link database.QueryOptions}.
      */
     batchSize?: number;
     /**
      * Time-to-live for the cursor in seconds. The cursor results may be
      * garbage collected by ArangoDB after this much time has passed.
      *
-     * See also {@link QueryOptions}.
+     * See also {@link database.QueryOptions}.
      */
     ttl?: number;
     /**
      * If set to `true`, the query will be executed as a streaming query.
      *
-     * See also {@link QueryOptions}.
+     * See also {@link database.QueryOptions}.
      */
     stream?: boolean;
 };
@@ -905,7 +1006,7 @@ export declare type TraversalOptions = {
      * access any other variables.
      *
      * See the official ArangoDB documentation for
-     * {@link https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html | the JavaScript `@arangodb` module}
+     * [the JavaScript `@arangodb` module](https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html)
      * for information about accessing the database from within ArangoDB's
      * server-side JavaScript environment.
      */
@@ -927,7 +1028,7 @@ export declare type TraversalOptions = {
      * access any other variables.
      *
      * See the official ArangoDB documentation for
-     * {@link https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html | the JavaScript `@arangodb` module}
+     * [the JavaScript `@arangodb` module](https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html)
      * for information about accessing the database from within ArangoDB's
      * server-side JavaScript environment.
      */
@@ -945,7 +1046,7 @@ export declare type TraversalOptions = {
      * access any other variables.
      *
      * See the official ArangoDB documentation for
-     * {@link https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html | the JavaScript `@arangodb` module}
+     * [the JavaScript `@arangodb` module](https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html)
      * for information about accessing the database from within ArangoDB's
      * server-side JavaScript environment.
      */
@@ -963,7 +1064,7 @@ export declare type TraversalOptions = {
      * access any other variables.
      *
      * See the official ArangoDB documentation for
-     * {@link https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html | the JavaScript `@arangodb` module}
+     * [the JavaScript `@arangodb` module](https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html)
      * for information about accessing the database from within ArangoDB's
      * server-side JavaScript environment.
      */
@@ -981,7 +1082,7 @@ export declare type TraversalOptions = {
      * access any other variables.
      *
      * See the official ArangoDB documentation for
-     * {@link https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html | the JavaScript `@arangodb` module}
+     * [the JavaScript `@arangodb` module](https://www.arangodb.com/docs/stable/appendix-java-script-modules-arango-db.html)
      * for information about accessing the database from within ArangoDB's
      * server-side JavaScript environment.
      */
@@ -1076,7 +1177,7 @@ export declare type CollectionEdgesResult<T extends Record<string, any> = any> =
 /**
  * Result of removing documents by an example.
  *
- * See {@link DocumentCollection.removeByExample} and {@link EdgeCollection.removeByExample}.
+ * See {@link DocumentCollection#removeByExample} and {@link EdgeCollection#removeByExample}.
  *
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
@@ -1090,7 +1191,7 @@ export declare type SimpleQueryRemoveByExampleResult = {
 /**
  * Result of replacing documents by an example.
  *
- * See {@link DocumentCollection.replaceByExample} and {@link EdgeCollection.replaceByExample}.
+ * See {@link DocumentCollection#replaceByExample} and {@link EdgeCollection#replaceByExample}.
  *
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
@@ -1104,7 +1205,7 @@ export declare type SimpleQueryReplaceByExampleResult = {
 /**
  * Result of updating documents by an example.
  *
- * See {@link DocumentCollection.updateByExample} and {@link EdgeCollection.updateByExample}.
+ * See {@link DocumentCollection#updateByExample} and {@link EdgeCollection#updateByExample}.
  *
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
@@ -1118,7 +1219,7 @@ export declare type SimpleQueryUpdateByExampleResult = {
 /**
  * Result of removing documents by keys.
  *
- * See {@link DocumentCollection.removeByKeys} and {@link EdgeCollection.removeByKeys}.
+ * See {@link DocumentCollection#removeByKeys} and {@link EdgeCollection#removeByKeys}.
  *
  * @deprecated Simple Queries have been deprecated in ArangoDB 3.4 and can be
  * replaced with AQL queries.
@@ -1138,7 +1239,7 @@ export declare type SimpleQueryRemoveByKeysResult<T extends Record<string, any>
     old?: DocumentMetadata[] | Document<T>[];
 };
 /**
- * Represents an document collection in a {@link Database}.
+ * Represents an document collection in a {@link database.Database}.
  *
  * See {@link EdgeCollection} for a variant of this interface more suited for
  * edge collections.
@@ -1181,12 +1282,12 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // data contains general information about the collection
      * ```
      */
-    get(): Promise<ArangoResponseMetadata & CollectionMetadata>;
+    get(): Promise<ArangoApiResponse<CollectionMetadata>>;
     /**
      * Creates a collection with the given `options` and the instance's name.
      *
-     * See also {@link Database.createCollection} and
-     * {@link Database.createEdgeCollection}.
+     * See also {@link database.Database#createCollection} and
+     * {@link database.Database#createEdgeCollection}.
      *
      * **Note**: When called on an {@link EdgeCollection} instance in TypeScript,
      * the `type` option must still be set to the correct {@link CollectionType}.
@@ -1227,7 +1328,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      */
     create(options?: CreateCollectionOptions & {
         type?: CollectionType;
-    }): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties>;
+    }): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
     /**
      * Retrieves the collection's properties.
      *
@@ -1239,7 +1340,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // data contains the collection's properties
      * ```
      */
-    properties(): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties>;
+    properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
     /**
      * Replaces the properties of the collection.
      *
@@ -1252,7 +1353,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // whenever a document is changed
      * ```
      */
-    properties(properties: CollectionPropertiesOptions): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties>;
+    properties(properties: CollectionPropertiesOptions): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
     /**
      * Retrieves information about the number of documents in a collection.
      *
@@ -1264,9 +1365,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // data contains the collection's count
      * ```
      */
-    count(): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties & {
+    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
         count: number;
-    }>;
+    }>>;
     /**
      * (RocksDB only.) Instructs ArangoDB to recalculate the collection's
      * document count to fix any inconsistencies.
@@ -1297,10 +1398,10 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // data contains the collection's figures
      * ```
      */
-    figures(details?: boolean): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties & {
+    figures(details?: boolean): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
         count: number;
-        figures: Dict<any>;
-    }>;
+        figures: Record<string, any>;
+    }>>;
     /**
      * Retrieves the collection revision ID.
      *
@@ -1312,9 +1413,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // data contains the collection's revision
      * ```
      */
-    revision(): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties & {
+    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
         revision: string;
-    }>;
+    }>>;
     /**
      * Retrieves the collection checksum.
      *
@@ -1328,47 +1429,10 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // data contains the collection's checksum
      * ```
      */
-    checksum(options?: CollectionChecksumOptions): Promise<ArangoResponseMetadata & CollectionMetadata & {
+    checksum(options?: CollectionChecksumOptions): Promise<ArangoApiResponse<CollectionMetadata & {
         revision: string;
         checksum: string;
-    }>;
-    /**
-     * (MMFiles only.) Instructs ArangoDB to load the collection into memory.
-     *
-     * @param count - Whether the number of documents in the collection should
-     * be included in the server response. Disabling this may speed up this
-     * process in future versions of ArangoDB.
-     *
-     * @example
-     * ```js
-     * const db = new Database();
-     * const collection = db.collection("some-collection");
-     * await collection.load();
-     * // the collection has now been loaded into memory
-     * ```
-     *
-     * @deprecated This method was deprecated in ArangoDB 3.8 as it no longer has
-     * any effect since the MMFiles storage engine was removed in ArangoDB 3.7.
-     */
-    load(count?: true): Promise<ArangoResponseMetadata & CollectionMetadata & {
-        count: number;
-    }>;
-    /**
-     * Instructs ArangoDB to load the collection into memory.
-     *
-     * @param count - Whether the number of documents in the collection should
-     * be included in the server response. Disabling this may speed up this
-     * process in future versions of ArangoDB.
-     *
-     * @example
-     * ```js
-     * const db = new Database();
-     * const collection = db.collection("some-collection");
-     * await collection.load(false);
-     * // the collection has now been loaded into memory
-     * ```
-     */
-    load(count: false): Promise<ArangoResponseMetadata & CollectionMetadata>;
+    }>>;
     /**
      * (RocksDB only.) Instructs ArangoDB to load as many indexes of the
      * collection into memory as permitted by the memory limit.
@@ -1382,25 +1446,10 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * ```
      */
     loadIndexes(): Promise<boolean>;
-    /**
-     * (MMFiles only.) Instructs ArangoDB to remove the collection from memory.
-     *
-     * @example
-     * ```js
-     * const db = new Database();
-     * const collection = db.collection("some-collection");
-     * await collection.unload();
-     * // the collection has now been unloaded from memory
-     * ```
-     *
-     * @deprecated This method was deprecated in ArangoDB 3.8 as it no longer has
-     * any effect since the MMFiles storage engine was removed in ArangoDB 3.7.
-     */
-    unload(): Promise<ArangoResponseMetadata & CollectionMetadata>;
     /**
      * Renames the collection and updates the instance's `name` to `newName`.
      *
-     * Additionally removes the instance from the {@link Database}'s internal
+     * Additionally removes the instance from the {@link database.Database}'s internal
      * cache.
      *
      * **Note**: Renaming collections may not be supported when ArangoDB is
@@ -1419,20 +1468,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // collection1 and collection3 represent the same ArangoDB collection!
      * ```
      */
-    rename(newName: string): Promise<ArangoResponseMetadata & CollectionMetadata>;
-    /**
-     * (MMFiles single-server only.) Rotates the journal of the collection.
-     *
-     * @example
-     * ```js
-     * const db = new Database();
-     * const collection = db.collection("some-collection");
-     * const rotated = await collection.rotate();
-     * ```
-     *
-     * @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
-     */
-    rotate(): Promise<boolean>;
+    rename(newName: string): Promise<ArangoApiResponse<CollectionMetadata>>;
     /**
      * Deletes all documents in the collection.
      *
@@ -1445,7 +1481,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // the collection "some-collection" is now empty
      * ```
      */
-    truncate(): Promise<ArangoResponseMetadata & CollectionMetadata>;
+    truncate(): Promise<ArangoApiResponse<CollectionMetadata>>;
     /**
      * Deletes the collection from the database.
      *
@@ -1459,7 +1495,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // The collection "some-collection" is now an ex-collection
      * ```
      */
-    drop(options?: CollectionDropOptions): Promise<ArangoResponseMetadata>;
+    drop(options?: CollectionDropOptions): Promise<ArangoApiResponse<Record<string, never>>>;
     /**
      * Retrieves the `shardId` of the shard responsible for the given document.
      *
@@ -1527,7 +1563,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * }
      * ```
      */
-    documentExists(selector: DocumentSelector): Promise<boolean>;
+    documentExists(selector: DocumentSelector, options?: DocumentExistsOptions): Promise<boolean>;
     /**
      * Retrieves the document matching the given key or id.
      *
@@ -1545,7 +1581,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * try {
      *   const document = await collection.document("abc123");
      *   console.log(document);
-     * } catch (e) {
+     * } catch (e: any) {
      *   console.error("Could not find document");
      * }
      * ```
@@ -1581,7 +1617,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * try {
      *   const document = await collection.document("abc123", false);
      *   console.log(document);
-     * } catch (e) {
+     * } catch (e: any) {
      *   console.error("Could not find document");
      * }
      * ```
@@ -1616,7 +1652,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * try {
      *   const documents = await collection.documents(["abc123", "xyz456"]);
      *   console.log(documents);
-     * } catch (e) {
+     * } catch (e: any) {
      *   console.error("Could not find document");
      * }
      * ```
@@ -1722,7 +1758,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
         _key: string;
     } | {
         _id: string;
-    })>, options?: CollectionReplaceOptions): Promise<Array<DocumentMetadata & {
+    })>, options?: Omit<CollectionReplaceOptions, "ifMatch">): Promise<Array<DocumentMetadata & {
         new?: Document<T>;
         old?: Document<T>;
     }>>;
@@ -1782,7 +1818,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
         _key: string;
     } | {
         _id: string;
-    })>, options?: CollectionUpdateOptions): Promise<Array<DocumentMetadata & {
+    })>, options?: Omit<CollectionUpdateOptions, "ifMatch">): Promise<Array<DocumentMetadata & {
         new?: Document<T>;
         old?: Document<T>;
     }>>;
@@ -1834,7 +1870,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // document with keys "abc123" and "def456" deleted
      * ```
      */
-    removeAll(selectors: DocumentSelector[], options?: CollectionRemoveOptions): Promise<Array<DocumentMetadata & {
+    removeAll(selectors: (string | ObjectWithKey)[], options?: Omit<CollectionRemoveOptions, "ifMatch">): Promise<Array<DocumentMetadata & {
         old?: Document<T>;
     }>>;
     /**
@@ -2094,7 +2130,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * const deleted = await cursor.next();
      * ```
      */
-    removeByExample(example: Partial<DocumentData<T>>, options?: SimpleQueryRemoveByExampleOptions): Promise<ArangoResponseMetadata & SimpleQueryRemoveByExampleResult>;
+    removeByExample(example: Partial<DocumentData<T>>, options?: SimpleQueryRemoveByExampleOptions): Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>;
     /**
      * Replaces all documents in the collection matching the given example.
      *
@@ -2125,7 +2161,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * const replaced = await cursor.next();
      * ```
      */
-    replaceByExample(example: Partial<DocumentData<T>>, newValue: DocumentData<T>, options?: SimpleQueryReplaceByExampleOptions): Promise<ArangoResponseMetadata & SimpleQueryReplaceByExampleResult>;
+    replaceByExample(example: Partial<DocumentData<T>>, newValue: DocumentData<T>, options?: SimpleQueryReplaceByExampleOptions): Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>;
     /**
      * Updates all documents in the collection matching the given example.
      *
@@ -2156,7 +2192,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * const updated = await cursor.next();
      * ```
      */
-    updateByExample(example: Partial<DocumentData<T>>, newValue: Patch<DocumentData<T>>, options?: SimpleQueryUpdateByExampleOptions): Promise<ArangoResponseMetadata & SimpleQueryUpdateByExampleResult>;
+    updateByExample(example: Partial<DocumentData<T>>, newValue: Patch<DocumentData<T>>, options?: SimpleQueryUpdateByExampleOptions): Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>;
     /**
      * Retrieves all documents matching the given document keys.
      *
@@ -2206,7 +2242,7 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * const ignored = keys.filter((key) => !removed.includes(key));
      * ```
      */
-    removeByKeys(keys: string[], options?: SimpleQueryRemoveByKeysOptions): Promise<ArangoResponseMetadata & SimpleQueryRemoveByKeysResult<T>>;
+    removeByKeys(keys: string[], options?: SimpleQueryRemoveByKeysOptions): Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>;
     /**
      * Performs a fulltext query in the given `attribute` on the collection.
      *
@@ -2271,61 +2307,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * });
      * ```
      */
-    ensureIndex(details: EnsurePersistentIndexOptions): Promise<ArangoResponseMetadata & PersistentIndex & {
+    ensureIndex(details: EnsurePersistentIndexOptions): Promise<ArangoApiResponse<PersistentIndex & {
         isNewlyCreated: boolean;
-    }>;
-    /**
-     * Creates a hash index on the collection if it does not already exist.
-     *
-     * When using the RocksDB storage engine, hash indexes behave identically
-     * to persistent indexes.
-     *
-     * @param details - Options for creating the hash index.
-     *
-     * @example
-     * ```js
-     * const db = new Database();
-     * const collection = db.collection("some-collection");
-     * // Create a unique index for looking up documents by username
-     * await collection.ensureIndex({
-     *   type: "hash",
-     *   fields: ["username"],
-     *   name: "unique-usernames",
-     *   unique: true
-     * });
-     * ```
-     *
-     * @deprecated Hash indexes have been deprecated in ArangoDB 3.9 and should
-     * be replaced with persistent indexes.
-     */
-    ensureIndex(details: EnsureHashIndexOptions): Promise<ArangoResponseMetadata & HashIndex & {
-        isNewlyCreated: boolean;
-    }>;
-    /**
-     * Creates a skiplist index on the collection if it does not already exist.
-     *
-     * When using the RocksDB storage engine, skiplist indexes behave identically
-     * to persistent indexes.
-     *
-     * @param details - Options for creating the skiplist index.
-     *
-     * @example
-     * ```js
-     * const db = new Database();
-     * const collection = db.collection("some-collection");
-     * // Create an index for sorting email addresses
-     * await collection.ensureIndex({
-     *   type: "skiplist",
-     *   fields: ["email"]
-     * });
-     * ```
-     *
-     * @deprecated Skiplist indexes have been deprecated in ArangoDB 3.9 and
-     * should be replaced with persistent indexes.
-     */
-    ensureIndex(details: EnsureSkiplistIndexOptions): Promise<ArangoResponseMetadata & SkiplistIndex & {
-        isNewlyCreated: boolean;
-    }>;
+    }>>;
     /**
      * Creates a TTL index on the collection if it does not already exist.
      *
@@ -2355,9 +2339,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * });
      * ```
      */
-    ensureIndex(details: EnsureTtlIndexOptions): Promise<ArangoResponseMetadata & TtlIndex & {
+    ensureIndex(details: EnsureTtlIndexOptions): Promise<ArangoApiResponse<TtlIndex & {
         isNewlyCreated: boolean;
-    }>;
+    }>>;
     /**
      * Creates a multi-dimensional index on the collection if it does not already exist.
      *
@@ -2376,14 +2360,17 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * ```
      * ```
      */
-    ensureIndex(details: EnsureZkdIndexOptions): Promise<ArangoResponseMetadata & ZkdIndex & {
+    ensureIndex(details: EnsureZkdIndexOptions): Promise<ArangoApiResponse<ZkdIndex & {
         isNewlyCreated: boolean;
-    }>;
+    }>>;
     /**
      * Creates a fulltext index on the collection if it does not already exist.
      *
      * @param details - Options for creating the fulltext index.
      *
+     * @deprecated Fulltext indexes have been deprecated in ArangoDB 3.10 and
+     * should be replaced with ArangoSearch.
+     *
      * @example
      * ```js
      * const db = new Database();
@@ -2396,9 +2383,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * });
      * ```
      */
-    ensureIndex(details: EnsureFulltextIndexOptions): Promise<ArangoResponseMetadata & FulltextIndex & {
+    ensureIndex(details: EnsureFulltextIndexOptions): Promise<ArangoApiResponse<FulltextIndex & {
         isNewlyCreated: boolean;
-    }>;
+    }>>;
     /**
      * Creates a geo index on the collection if it does not already exist.
      *
@@ -2416,9 +2403,28 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * });
      * ```
      */
-    ensureIndex(details: EnsureGeoIndexOptions): Promise<ArangoResponseMetadata & GeoIndex & {
+    ensureIndex(details: EnsureGeoIndexOptions): Promise<ArangoApiResponse<GeoIndex & {
         isNewlyCreated: boolean;
-    }>;
+    }>>;
+    /**
+     * Creates a inverted index on the collection if it does not already exist.
+     *
+     * @param details - Options for creating the inverted index.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const collection = db.collection("some-collection");
+     * // Create an inverted index
+     * await collection.ensureIndex({
+     *   type: "inverted",
+     *   fields: ["a", { name: "b", analyzer: "text_en" }]
+     * });
+     * ```
+     */
+    ensureIndex(details: EnsureInvertedIndexOptions): Promise<ArangoApiResponse<InvertedIndex & {
+        isNewlyCreated: boolean;
+    }>>;
     /**
      * Deletes the index with the given name or `id` from the database.
      *
@@ -2432,9 +2438,9 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // The index "some-index" no longer exists
      * ```
      */
-    dropIndex(selector: IndexSelector): Promise<ArangoResponseMetadata & {
+    dropIndex(selector: IndexSelector): Promise<ArangoApiResponse<{
         id: string;
-    }>;
+    }>>;
     /**
      * Triggers compaction for a collection.
      *
@@ -2446,16 +2452,16 @@ export interface DocumentCollection<T extends Record<string, any> = any> extends
      * // Background compaction is triggered on the collection
      * ```
      */
-    compact(): Promise<ArangoResponseMetadata>;
+    compact(): Promise<ArangoApiResponse<Record<string, never>>>;
 }
 /**
- * Represents an edge collection in a {@link Database}.
+ * Represents an edge collection in a {@link database.Database}.
  *
  * See {@link DocumentCollection} for a more generic variant of this interface
  * more suited for regular document collections.
  *
- * See also {@link GraphEdgeCollection} for the type representing an edge
- * collection in a {@link Graph}.
+ * See also {@link graph.GraphEdgeCollection} for the type representing an edge
+ * collection in a {@link graph.Graph}.
  *
  * When using TypeScript, collections can be cast to a specific edge document
  * data type to increase type safety.
@@ -2490,7 +2496,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * try {
      *   const document = await collection.document("abc123");
      *   console.log(document);
-     * } catch (e) {
+     * } catch (e: any) {
      *   console.error("Could not find document");
      * }
      * ```
@@ -2526,7 +2532,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * try {
      *   const document = await collection.document("abc123", false);
      *   console.log(document);
-     * } catch (e) {
+     * } catch (e: any) {
      *   console.error("Could not find document");
      * }
      * ```
@@ -2561,7 +2567,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * try {
      *   const documents = await collection.documents(["abc123", "xyz456"]);
      *   console.log(documents);
-     * } catch (e) {
+     * } catch (e: any) {
      *   console.error("Could not find document");
      * }
      * ```
@@ -3054,6 +3060,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      *
      * @param selector - Document `_key`, `_id` or object with either of those
      * properties (e.g. a document from this collection).
+     * @param options - Options for retrieving the edges.
      *
      * @example
      * ```js
@@ -3069,7 +3076,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * console.log(edges.map((edge) => edge._key)); // ["x", "y", "z"]
      * ```
      */
-    edges(selector: DocumentSelector): Promise<ArangoResponseMetadata & CollectionEdgesResult<T>>;
+    edges(selector: DocumentSelector, options: CollectionEdgesOptions): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
     /**
      * Retrieves a list of all incoming edges of the document matching the given
      * `selector`.
@@ -3079,6 +3086,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      *
      * @param selector - Document `_key`, `_id` or object with either of those
      * properties (e.g. a document from this collection).
+     * @param options - Options for retrieving the edges.
      *
      * @example
      * ```js
@@ -3094,7 +3102,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * console.log(edges.map((edge) => edge._key)); // ["z"]
      * ```
      */
-    inEdges(selector: DocumentSelector): Promise<ArangoResponseMetadata & CollectionEdgesResult<T>>;
+    inEdges(selector: DocumentSelector, options: CollectionEdgesOptions): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
     /**
      * Retrieves a list of all outgoing edges of the document matching the given
      * `selector`.
@@ -3104,6 +3112,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      *
      * @param selector - Document `_key`, `_id` or object with either of those
      * properties (e.g. a document from this collection).
+     * @param options - Options for retrieving the edges.
      *
      * @example
      * ```js
@@ -3119,7 +3128,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * console.log(edges.map((edge) => edge._key)); // ["x", "y"]
      * ```
      */
-    outEdges(selector: DocumentSelector): Promise<ArangoResponseMetadata & CollectionEdgesResult<T>>;
+    outEdges(selector: DocumentSelector, options: CollectionEdgesOptions): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
     /**
      * Performs a traversal starting from the given `startVertex` and following
      * edges contained in this edge collection.
@@ -3127,7 +3136,7 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      * Throws an exception when passed a document or `_id` from a different
      * collection.
      *
-     * See also {@link Graph.traversal}.
+     * See also {@link graph.Graph#traversal}.
      *
      * @param startVertex - Document `_key`, `_id` or object with either of those
      * properties (e.g. a document from this collection).
@@ -3146,30 +3155,27 @@ export interface EdgeCollection<T extends Record<string, any> = any> extends Doc
      *   ["y", "vertices/b", "vertices/c"],
      *   ["z", "vertices/c", "vertices/d"],
      * ]);
-     * const result = await collection.traversal("vertices/a", {
-     *   direction: "outbound",
-     *   init: "result.vertices = [];",
-     *   visitor: "result.vertices.push(vertex._key);",
-     * });
-     * console.log(result.vertices); // ["a", "b", "c", "d"]
+     * const startVertex = "vertices/a";
+     * const cursor = await db.query(aql`
+     *   FOR vertex IN OUTBOUND ${startVertex}
+     *   RETURN vertex._key
+     * `);
+     * const result = await cursor.all();
+     * console.log(result); // ["a", "b", "c", "d"]
      * ```
      */
     traversal(startVertex: DocumentSelector, options?: TraversalOptions): Promise<any>;
 }
 /**
  * @internal
- * @hidden
  */
 export declare class Collection<T extends Record<string, any> = any> implements EdgeCollection<T>, DocumentCollection<T> {
     protected _name: string;
     protected _db: Database;
     /**
      * @internal
-     * @hidden
      */
     constructor(db: Database, name: string);
-    protected _get<T extends Record<string, any>>(path: string, qs?: any): Promise<ArangoResponseMetadata & T>;
-    protected _put<T extends Record<string, any>>(path: string, body?: any): Promise<ArangoResponseMetadata & T>;
     get isArangoCollection(): true;
     get name(): string;
     get(): Promise<any>;
@@ -3177,34 +3183,29 @@ export declare class Collection<T extends Record<string, any> = any> implements
     create(options?: CreateCollectionOptions & {
         type?: CollectionType;
     }): Promise<any>;
-    properties(properties?: CollectionPropertiesOptions): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties>;
-    count(): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties & {
+    properties(properties?: CollectionPropertiesOptions): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
+    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
         count: number;
-    }>;
+    }>>;
     recalculateCount(): Promise<boolean>;
-    figures(details?: boolean): Promise<CollectionMetadata & CollectionProperties & {
+    figures(details?: boolean): Promise<CollectionMetadata & ArangoApiResponse<CollectionProperties & {
         count: number;
-        figures: Dict<any>;
-    } & ArangoResponseMetadata>;
-    revision(): Promise<ArangoResponseMetadata & CollectionMetadata & CollectionProperties & {
+        figures: Record<string, any>;
+    }>>;
+    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
         revision: string;
-    }>;
-    checksum(options?: CollectionChecksumOptions): Promise<ArangoResponseMetadata & CollectionMetadata & {
+    }>>;
+    checksum(options?: CollectionChecksumOptions): Promise<ArangoApiResponse<CollectionMetadata & {
         revision: string;
         checksum: string;
-    }>;
-    load(count?: boolean): Promise<ArangoResponseMetadata & CollectionMetadata & {
-        count: number;
-    }>;
+    }>>;
     loadIndexes(): Promise<boolean>;
-    unload(): Promise<ArangoResponseMetadata & CollectionMetadata>;
-    rename(newName: string): Promise<ArangoResponseMetadata & CollectionMetadata>;
-    rotate(): Promise<boolean>;
-    truncate(): Promise<ArangoResponseMetadata & CollectionMetadata>;
+    rename(newName: string): Promise<ArangoApiResponse<CollectionMetadata>>;
+    truncate(): Promise<ArangoApiResponse<CollectionMetadata>>;
     drop(options?: CollectionDropOptions): Promise<any>;
     getResponsibleShard(document: Partial<Document<T>>): Promise<string>;
     documentId(selector: DocumentSelector): string;
-    documentExists(selector: DocumentSelector): Promise<boolean>;
+    documentExists(selector: DocumentSelector, options?: DocumentExistsOptions): Promise<boolean>;
     documents(selectors: (string | ObjectWithKey)[], options?: CollectionBatchReadOptions): Promise<any>;
     document(selector: DocumentSelector, options?: boolean | CollectionReadOptions): Promise<any>;
     save(data: DocumentData<T>, options?: CollectionInsertOptions): Promise<any>;
@@ -3222,14 +3223,14 @@ export declare class Collection<T extends Record<string, any> = any> implements
         _id: string;
     })>, options?: CollectionUpdateOptions): Promise<any>;
     remove(selector: DocumentSelector, options?: CollectionRemoveOptions): Promise<any>;
-    removeAll(selectors: DocumentSelector[], options?: CollectionRemoveOptions): Promise<any>;
+    removeAll(selectors: (string | ObjectWithKey)[], options?: CollectionRemoveOptions): Promise<any>;
     import(data: Buffer | Blob | string | any[], options?: CollectionImportOptions & {
         type?: "documents" | "list" | "auto";
     }): Promise<CollectionImportResult>;
-    protected _edges(selector: DocumentSelector, direction?: "in" | "out"): Promise<any>;
-    edges(vertex: DocumentSelector): Promise<any>;
-    inEdges(vertex: DocumentSelector): Promise<any>;
-    outEdges(vertex: DocumentSelector): Promise<any>;
+    protected _edges(selector: DocumentSelector, options: CollectionEdgesOptions, direction?: "in" | "out"): Promise<any>;
+    edges(vertex: DocumentSelector, options: CollectionEdgesOptions): Promise<any>;
+    inEdges(vertex: DocumentSelector, options: CollectionEdgesOptions): Promise<any>;
+    outEdges(vertex: DocumentSelector, options: CollectionEdgesOptions): Promise<any>;
     traversal(startVertex: DocumentSelector, options?: TraversalOptions): Promise<any>;
     list(type?: SimpleQueryListType): Promise<ArrayCursor<any>>;
     all(options?: SimpleQueryAllOptions): Promise<ArrayCursor<any>>;
@@ -3243,7 +3244,7 @@ export declare class Collection<T extends Record<string, any> = any> implements
     removeByKeys(keys: string[], options?: SimpleQueryRemoveByKeysOptions): Promise<any>;
     indexes(): Promise<any>;
     index(selector: IndexSelector): Promise<any>;
-    ensureIndex(options: EnsureHashIndexOptions | EnsureSkiplistIndexOptions | EnsurePersistentIndexOptions | EnsureGeoIndexOptions | EnsureFulltextIndexOptions | EnsureTtlIndexOptions | EnsureZkdIndexOptions): Promise<any>;
+    ensureIndex(options: EnsurePersistentIndexOptions | EnsureGeoIndexOptions | EnsureFulltextIndexOptions | EnsureTtlIndexOptions | EnsureZkdIndexOptions | EnsureInvertedIndexOptions): Promise<any>;
     dropIndex(selector: IndexSelector): Promise<any>;
     fulltext(attribute: string, query: string, { index, ...options }?: SimpleQueryFulltextOptions): Promise<ArrayCursor<any>>;
     compact(): Promise<any>;