@uipath/uipath-typescript 1.3.10 → 1.4.0

package/dist/entities/index.d.ts

@@ -107,6 +107,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
             tokenParam?: string;
             countParam?: string;
             convertToSkip?: boolean;
+            zeroBased?: boolean;
         };
     };
 }
@@ -341,7 +342,7 @@ interface EntityRecord {
 type EntityGetRecordsByIdOptions = {
     /** Level of entity expansion (default: 0) */
     expansionLevel?: number;
-} & PaginationOptions;
+} & PaginationOptions & EntityFolderScopedOptions;
 /**
  * Options for getting all records of an entity
  */
@@ -349,14 +350,14 @@ type EntityGetAllRecordsOptions = EntityGetRecordsByIdOptions;
 /**
  * Options for getting a single entity record by entity ID and record ID
  */
-interface EntityGetRecordByIdOptions {
+interface EntityGetRecordByIdOptions extends EntityFolderScopedOptions {
     /** Level of entity expansion (default: 0) */
     expansionLevel?: number;
 }
 /**
  * Common options for entity operations that modify multiple records
  */
-interface EntityOperationOptions {
+interface EntityOperationOptions extends EntityFolderScopedOptions {
     /** Level of entity expansion (default: 0) */
     expansionLevel?: number;
     /** Whether to fail on first error (default: false) */
@@ -366,7 +367,7 @@ interface EntityOperationOptions {
  * Options for inserting a single record into an entity
  * @deprecated Use {@link EntityInsertRecordOptions} instead for better clarity on inserting a single record into an entity. This type will be removed in future versions.
  */
-interface EntityInsertOptions {
+interface EntityInsertOptions extends EntityFolderScopedOptions {
     /** Level of entity expansion (default: 0) */
     expansionLevel?: number;
 }
@@ -406,7 +407,7 @@ interface EntityUpdateRecordsOptions extends EntityOperationOptions {
  * Options for deleting data from an entity
  * @deprecated Use {@link EntityDeleteRecordsOptions} instead for better clarity on deleting records from an entity. This type will be removed in future versions.
  */
-interface EntityDeleteOptions {
+interface EntityDeleteOptions extends EntityFolderScopedOptions {
     /** Whether to fail on first error (default: false) */
     failOnFirst?: boolean;
 }
@@ -415,6 +416,16 @@ interface EntityDeleteOptions {
  */
 interface EntityDeleteRecordsOptions extends EntityDeleteOptions {
 }
+/**
+ * Options for {@link EntityServiceModel.deleteRecordById}
+ */
+interface EntityDeleteRecordByIdOptions extends EntityFolderScopedOptions {
+}
+/**
+ * Options for {@link EntityServiceModel.importRecordsById}
+ */
+interface EntityImportRecordsByIdOptions extends EntityFolderScopedOptions {
+}
 /**
  * Logical operator for combining query filter groups
  */
@@ -523,7 +534,7 @@ type EntityQueryRecordsOptions = {
     aggregates?: EntityAggregate[];
     /** Field names to group aggregate results by. */
     groupBy?: string[];
-} & PaginationOptions;
+} & PaginationOptions & EntityFolderScopedOptions;
 /**
  * Response from querying entity records
  */
@@ -549,6 +560,8 @@ interface EntityFieldBase {
     isRbacEnabled?: boolean;
     /** Whether the field value is encrypted at rest (default: false) */
     isEncrypted?: boolean;
+    /** Whether the field is hidden from the UI (default: false) */
+    isHiddenField?: boolean;
     /** Default value for the field */
     defaultValue?: string;
     /** Maximum character length for STRING fields (default: 200, range: 1–4000) and MULTILINE_TEXT fields (default: 200, range: 1–10000). */
@@ -573,21 +586,37 @@ interface EntityCreateFieldOptions extends EntityFieldBase {
     type?: EntityFieldDataType;
     /** Choice set ID for choice-set fields */
     choiceSetId?: string;
-    /** Name of the referenced entity for relationship fields */
-    referenceEntityName?: string;
-    /** Name of the field in the referenced entity */
-    referenceFieldName?: string;
+    /** UUID of the referenced entity (required when `type` is `RELATIONSHIP` or `FILE`) */
+    referenceEntityId?: string;
+    /** UUID of the referenced field on the target entity (required when `type` is `RELATIONSHIP` or `FILE`) */
+    referenceFieldId?: string;
+}
+/**
+ * Common shape for every folder-scoped Data Fabric entity operation.
+ * Forwarded on the wire as the `X-UIPATH-FolderKey` header.
+ */
+interface EntityFolderScopedOptions {
+    /** Key identifying the folder the entity belongs to. Omit for tenant-level entities. */
+    folderKey?: string;
+}
+/**
+ * Options for {@link EntityServiceModel.getById}
+ */
+interface EntityGetByIdOptions extends EntityFolderScopedOptions {
+}
+/**
+ * Options for {@link EntityServiceModel.deleteById}
+ */
+interface EntityDeleteByIdOptions extends EntityFolderScopedOptions {
 }
 /**
  * Options for creating a new Data Fabric entity
  */
-interface EntityCreateOptions {
+interface EntityCreateOptions extends EntityFolderScopedOptions {
     /** Human-readable display name shown in the UI (defaults to `name` if omitted) */
     displayName?: string;
     /** Optional entity description */
     description?: string;
-    /** UUID of the folder to place the entity in (defaults to the tenant-level folder) */
-    folderKey?: string;
     /** Whether role-based access control is enabled for this entity (default: false) */
     isRbacEnabled?: boolean;
     /** Whether Analytics integration is enabled for this entity (default: false) */
@@ -616,7 +645,7 @@ interface EntityRemoveFieldOptions {
  * (`displayName`, `description`, `isRbacEnabled`) can be combined; each is applied
  * only when the corresponding fields are provided.
  */
-interface EntityUpdateByIdOptions {
+interface EntityUpdateByIdOptions extends EntityFolderScopedOptions {
     /** New fields to add */
     addFields?: EntityCreateFieldOptions[];
     /** Fields to remove, each identified by field name */
@@ -648,10 +677,20 @@ type EntityFileType = Blob | File | Uint8Array;
 /**
  * Optional options for uploading an attachment to an entity record
  */
-interface EntityUploadAttachmentOptions {
+interface EntityUploadAttachmentOptions extends EntityFolderScopedOptions {
     /** Optional expansion level (default: 0) */
     expansionLevel?: number;
 }
+/**
+ * Optional options for downloading an attachment from an entity record
+ */
+interface EntityDownloadAttachmentOptions extends EntityFolderScopedOptions {
+}
+/**
+ * Optional options for deleting an attachment from an entity record
+ */
+interface EntityDeleteAttachmentOptions extends EntityFolderScopedOptions {
+}
 /**
  * Response from uploading an attachment to an entity record
  */
@@ -806,10 +845,6 @@ interface FieldMetaData {
     referenceType?: ReferenceType;
     choiceSetId?: string;
     defaultValue?: string;
-    /** Name of the referenced entity (used on write payloads for relationship fields) */
-    referenceEntityName?: string;
-    /** Name of the field in the referenced entity (used on write payloads for relationship fields) */
-    referenceFieldName?: string;
 }
 /**
  * External object details
@@ -955,6 +990,7 @@ interface EntityServiceModel {
      * Gets entity metadata by entity ID with attached operation methods
      *
      * @param id - UUID of the entity
+     * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to entity metadata with operation methods
      * {@link EntityGetResponse}
      * @example
@@ -967,6 +1003,9 @@ interface EntityServiceModel {
      * // Get entity metadata with methods
      * const entity = await entities.getById("<entityId>");
      *
+     * // Folder-scoped: pass the entity's folder key
+     * const folderEntity = await entities.getById("<entityId>", { folderKey: "<folderKey>" });
+     *
      * // Call operations directly on the entity
      * const records = await entity.getAllRecords();
      *
@@ -986,7 +1025,7 @@ interface EntityServiceModel {
      * ]);
      * ```
      */
-    getById(id: string): Promise<EntityGetResponse>;
+    getById(id: string, options?: EntityGetByIdOptions): Promise<EntityGetResponse>;
     /**
      * Gets entity records by entity ID
      *
@@ -1190,6 +1229,7 @@ interface EntityServiceModel {
      *
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record to delete
+     * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to void on success
      * @example
      * ```typescript
@@ -1198,9 +1238,12 @@ interface EntityServiceModel {
      * const entities = new Entities(sdk);
      *
      * await entities.deleteRecordById("<entityId>", "<recordId>");
+     *
+     * // Folder-scoped: pass the entity's folder key
+     * await entities.deleteRecordById("<entityId>", "<recordId>", { folderKey: "<folderKey>" });
      * ```
      */
-    deleteRecordById(entityId: string, recordId: string): Promise<void>;
+    deleteRecordById(entityId: string, recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
     /**
      * Queries entity records with filters, sorting, aggregates, and SDK-managed pagination
      *
@@ -1254,6 +1297,7 @@ interface EntityServiceModel {
      *
      * @param id - UUID of the entity
      * @param file - CSV file to import as a Blob or File or Uint8Array
+     * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to {@link EntityImportRecordsResponse} with record counts
      * @example
      * ```typescript
@@ -1261,16 +1305,19 @@ interface EntityServiceModel {
      * const fileInput = document.getElementById('csv-input') as HTMLInputElement;
      * const result = await entities.importRecordsById(<id>, fileInput.files[0]);
      * console.log(`Inserted ${result.insertedRecords} of ${result.totalRecords} records`);
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.importRecordsById(<id>, fileInput.files[0], { folderKey: "<folderKey>" });
      * ```
-     * @internal
      */
-    importRecordsById(id: string, file: EntityFileType): Promise<EntityImportRecordsResponse>;
+    importRecordsById(id: string, file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
     /**
      * Downloads an attachment stored in a File-type field of an entity record.
      *
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record containing the attachment
      * @param fieldName - Name of the File-type field containing the attachment
+     * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to Blob containing the file content
      * @example
      * ```typescript
@@ -1317,7 +1364,7 @@ interface EntityServiceModel {
      * fs.writeFileSync('attachment.pdf', buffer);
      * ```
      */
-    downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
+    downloadAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
     /**
      * Uploads an attachment to a File-type field of an entity record.
      *
@@ -1327,7 +1374,7 @@ interface EntityServiceModel {
      * @param recordId - UUID of the record to upload the attachment to
      * @param fieldName - Name of the File-type field
      * @param file - File to upload (Blob, File, or Uint8Array)
-     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
+     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
      * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
      * @example
      * ```typescript
@@ -1348,6 +1395,9 @@ interface EntityServiceModel {
      * const file = fileInput.files[0];
      * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
      *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.uploadAttachment(entityId, recordId, 'Documents', file, { folderKey: "<folderKey>" });
+     *
      * // Node.js: Upload a file from disk
      * const fileBuffer = fs.readFileSync('document.pdf');
      * const blob = new Blob([fileBuffer], { type: 'application/pdf' });
@@ -1361,6 +1411,7 @@ interface EntityServiceModel {
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record containing the attachment
      * @param fieldName - Name of the File-type field containing the attachment
+     * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
      * @example
      * ```typescript
@@ -1384,7 +1435,7 @@ interface EntityServiceModel {
      * await entity.deleteAttachment(recordId, 'Documents');
      * ```
      */
-    deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
+    deleteAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
     /**
      * Creates a new Data Fabric entity with the given schema
      *
@@ -1418,14 +1469,18 @@ interface EntityServiceModel {
      * Deletes a Data Fabric entity and all its records
      *
      * @param id - UUID of the entity to delete
+     * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving when the entity is deleted
      * @example
      * ```typescript
      * await entities.deleteById(<id>);
+     *
+     * // Folder-scoped: pass the entity's folder key
+     * await entities.deleteById(<id>, { folderKey: "<folderKey>" });
      * ```
      * @internal
      */
-    deleteById(id: string): Promise<void>;
+    deleteById(id: string, options?: EntityDeleteByIdOptions): Promise<void>;
     /**
      * Updates an existing Data Fabric entity — schema and/or metadata.
      *
@@ -1434,7 +1489,6 @@ interface EntityServiceModel {
      * only when the corresponding fields are provided.
      *
      * @param id - UUID of the entity to update
-     * @param name - name of the entity (required by the API)
      * @param options - Changes to apply ({@link EntityUpdateByIdOptions})
      * @returns Promise resolving when the update is complete
      *
@@ -1468,6 +1522,12 @@ interface EntityServiceModel {
      *     { id: <fieldId>, lengthLimit: 1000 },
      *   ],
      * });
+     *
+     * // Folder-scoped entity: add a field to an entity that lives in a non-tenant folder
+     * await entities.updateById(<id>, {
+     *   folderKey: "<folderKey>",
+     *   addFields: [{ fieldName: "notes", type: EntityFieldDataType.MULTILINE_TEXT }],
+     * });
      * ```
      * @internal
      */
@@ -1540,9 +1600,10 @@ interface EntityMethods {
      * Use this method if you need trigger events to fire for the deleted record.
      *
      * @param recordId - UUID of the record to delete
+     * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to void on success
      */
-    deleteRecord(recordId: string): Promise<void>;
+    deleteRecord(recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
     /**
      * Get all records from this entity
      *
@@ -1563,16 +1624,17 @@ interface EntityMethods {
      *
      * @param recordId - UUID of the record containing the attachment
      * @param fieldName - Name of the File-type field containing the attachment
+     * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. folderKey)
      * @returns Promise resolving to Blob containing the file content
      */
-    downloadAttachment(recordId: string, fieldName: string): Promise<Blob>;
+    downloadAttachment(recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
     /**
      * Uploads an attachment to a File-type field of an entity record
      *
      * @param recordId - UUID of the record to upload the attachment to
      * @param fieldName - Name of the File-type field
      * @param file - File to upload (Blob, File, or Uint8Array)
-     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
+     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel, folderKey)
      * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
      */
     uploadAttachment(recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
@@ -1581,9 +1643,10 @@ interface EntityMethods {
      *
      * @param recordId - UUID of the record containing the attachment
      * @param fieldName - Name of the File-type field containing the attachment
+     * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. folderKey)
      * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
      */
-    deleteAttachment(recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
+    deleteAttachment(recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
     /**
      * @deprecated Use {@link insertRecord} instead.
      * @hidden
@@ -1639,6 +1702,7 @@ interface EntityMethods {
      * Imports records from a CSV file into this entity
      *
      * @param file - CSV file to import as a Blob, File, or Uint8Array
+     * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to {@link EntityImportRecordsResponse} with record counts
      * @example
      * ```typescript
@@ -1646,9 +1710,12 @@ interface EntityMethods {
      * const fileInput = document.getElementById('csv-input') as HTMLInputElement;
      * const result = await entity.importRecords(fileInput.files[0]);
      * console.log(`Inserted ${result.insertedRecords} of ${result.totalRecords} records`);
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entity.importRecords(fileInput.files[0], { folderKey: "<folderKey>" });
      * ```
      */
-    importRecords(file: EntityFileType): Promise<EntityImportRecordsResponse>;
+    importRecords(file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
     /**
      * @deprecated Use {@link getAllRecords} instead.
      * @hidden
@@ -1657,15 +1724,19 @@ interface EntityMethods {
     /**
      * Deletes this entity and all its records
      *
+     * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving when the entity is deleted
      * @example
      * ```typescript
      * const entity = await entities.getById(<id>);
      * await entity.delete();
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entity.delete({ folderKey: "<folderKey>" });
      * ```
      * @internal
      */
-    delete(): Promise<void>;
+    delete(options?: EntityDeleteByIdOptions): Promise<void>;
     /**
      * Updates this entity — schema and/or metadata.
      *
@@ -1712,6 +1783,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * Gets entity metadata by entity ID with attached operation methods
      *
      * @param id - UUID of the entity
+     * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to entity metadata with schema information and operation methods
      *
      * @example
@@ -1721,6 +1793,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * const entities = new Entities(sdk);
      * const entity = await entities.getById("<entityId>");
      *
+     * // Folder-scoped: pass the entity's folder key
+     * const folderEntity = await entities.getById("<entityId>", { folderKey: "<folderKey>" });
+     *
      * // Call operations directly on the entity
      * const records = await entity.getAllRecords();
      *
@@ -1734,7 +1809,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * ]);
      * ```
      */
-    getById(id: string): Promise<EntityGetResponse>;
+    getById(id: string, options?: EntityGetByIdOptions): Promise<EntityGetResponse>;
     /**
      * Gets entity records by entity ID
      *
@@ -1933,6 +2008,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record to delete
+     * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to void on success
      * @example
      * ```typescript
@@ -1941,9 +2017,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * const entities = new Entities(sdk);
      *
      * await entities.deleteRecordById("<entityId>", "<recordId>");
+     *
+     * // Folder-scoped: pass the entity's folder key
+     * await entities.deleteRecordById("<entityId>", "<recordId>", { folderKey: "<folderKey>" });
      * ```
      */
-    deleteRecordById(entityId: string, recordId: string): Promise<void>;
+    deleteRecordById(entityId: string, recordId: string, options?: EntityDeleteRecordByIdOptions): Promise<void>;
     /**
      * Gets all entities in the system
      *
@@ -2022,6 +2101,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *
      * @param id - UUID of the entity
      * @param file - CSV file to import (Blob, File, or Uint8Array)
+     * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to import result with record counts
      *
      * @example
@@ -2042,16 +2122,19 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * if (result.errorFileLink) {
      *   console.log(`Error file link: ${result.errorFileLink}`);
      * }
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.importRecordsById("<entityId>", fileInput.files[0], { folderKey: "<folderKey>" });
      * ```
-     * @internal
      */
-    importRecordsById(id: string, file: EntityFileType): Promise<EntityImportRecordsResponse>;
+    importRecordsById(id: string, file: EntityFileType, options?: EntityImportRecordsByIdOptions): Promise<EntityImportRecordsResponse>;
     /**
      * Downloads an attachment from an entity record field
      *
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record containing the attachment
      * @param fieldName - Name of the File-type field containing the attachment
+     * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to Blob containing the file content
      *
      * @example
@@ -2070,9 +2153,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *
      * // Download attachment for a specific record and field
      * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents');
+     *
+     * // Folder-scoped: pass the entity's folder key
+     * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents', { folderKey: "<folderKey>" });
      * ```
      */
-    downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
+    downloadAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDownloadAttachmentOptions): Promise<Blob>;
     /**
      * Uploads an attachment to a File-type field of an entity record
      *
@@ -2080,7 +2166,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * @param recordId - UUID of the record to upload the attachment to
      * @param fieldName - Name of the File-type field
      * @param file - File to upload (Blob, File, or Uint8Array)
-     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
+     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities)
      * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
      *
      * @example
@@ -2099,6 +2185,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *
      * // Upload a file attachment
      * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.uploadAttachment(entityId, recordId, 'Documents', file, { folderKey: "<folderKey>" });
      * ```
      */
     uploadAttachment(entityId: string, recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
@@ -2108,6 +2197,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record containing the attachment
      * @param fieldName - Name of the File-type field containing the attachment
+     * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
      *
      * @example
@@ -2126,9 +2216,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *
      * // Delete attachment for a specific record and field
      * await entities.deleteAttachment(entityId, recordId, 'Documents');
+     *
+     * // Folder-scoped: pass the entity's folder key
+     * await entities.deleteAttachment(entityId, recordId, 'Documents', { folderKey: "<folderKey>" });
      * ```
      */
-    deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
+    deleteAttachment(entityId: string, recordId: string, fieldName: string, options?: EntityDeleteAttachmentOptions): Promise<EntityDeleteAttachmentResponse>;
     /**
    * @hidden
    * @deprecated Use {@link getAllRecords} instead.
@@ -2174,15 +2267,19 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * Deletes a Data Fabric entity and all its records
      *
      * @param id - UUID of the entity to delete
+     * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
      * @returns Promise resolving when the entity is deleted
      *
      * @example
      * ```typescript
      * await entities.deleteById("<entityId>");
+     *
+     * // Folder-scoped: pass the entity's folder key
+     * await entities.deleteById("<entityId>", { folderKey: "<folderKey>" });
      * ```
      * @internal
      */
-    deleteById(id: string): Promise<void>;
+    deleteById(id: string, options?: EntityDeleteByIdOptions): Promise<void>;
     /**
      * Updates an existing Data Fabric entity — schema and/or metadata.
      *
@@ -2228,6 +2325,12 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *     { id: "<fieldId>", lengthLimit: 1000 },
      *   ],
      * });
+     *
+     * // Folder-scoped entity: add a field to an entity that lives in a non-tenant folder
+     * await entities.updateById("<entityId>", {
+     *   folderKey: "<folderKey>",
+     *   addFields: [{ fieldName: "notes", type: EntityFieldDataType.MULTILINE_TEXT }],
+     * });
      * ```
      * @internal
      */
@@ -2296,8 +2399,6 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * override the defaults where the type accepts overrides.
      */
     private buildSqlTypeConstraints;
-    private static readonly RESERVED_FIELD_NAMES;
-    private validateName;
 }
 
 /**
@@ -2802,4 +2903,4 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
 }
 
 export { ChoiceSetService, ChoiceSetService as ChoiceSets, DataDirectionType, EntityService as Entities, EntityAggregateFunction, EntityFieldDataType, EntityService, EntityType, FieldDisplayType, JoinType, LogicalOperator, QueryFilterOperator, ReferenceType, createEntityWithMethods };
-export type { ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, RawEntityGetResponse, SourceJoinCriteria, SqlType };
+export type { ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentOptions, EntityDeleteAttachmentResponse, EntityDeleteByIdOptions, EntityDeleteOptions, EntityDeleteRecordByIdOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityDownloadAttachmentOptions, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityFolderScopedOptions, EntityGetAllRecordsOptions, EntityGetByIdOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsByIdOptions, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, RawEntityGetResponse, SourceJoinCriteria, SqlType };