@uipath/uipath-typescript 1.1.3 → 1.2.1

package/dist/entities/index.d.ts

@@ -368,9 +368,13 @@ type EntityBatchInsertOptions = EntityOperationOptions;
  * Options for inserting multiple records into an entity
  */
 type EntityInsertRecordsOptions = EntityOperationOptions;
+/**
+ * Options for updating a single record in an entity
+ */
+type EntityUpdateRecordOptions = EntityGetRecordByIdOptions;
 /**
  * Options for updating data in an entity
- * @deprecated Use {@link EntityUpdateRecordOptions} instead for better clarity on updating records in an entity. This type will be removed in future versions.
+ * @deprecated Use {@link EntityUpdateRecordsOptions} instead for better clarity on updating records in an entity. This type will be removed in future versions.
  */
 type EntityUpdateOptions = EntityOperationOptions;
 /**
@@ -390,34 +394,13 @@ interface EntityDeleteOptions {
  */
 type EntityDeleteRecordsOptions = EntityDeleteOptions;
 /**
- * Options for downloading an attachment from an entity record
+ * Supported file types for attachment upload
  */
-interface EntityDownloadAttachmentOptions {
-    /** Entity name */
-    entityName: string;
-    /** Record ID */
-    recordId: string;
-    /** Field name containing the attachment */
-    fieldName: string;
-}
+type EntityFileType = Blob | File | Uint8Array;
 /**
- * Options for uploading an attachment to an entity record
+ * Optional options for uploading an attachment to an entity record
  */
 interface EntityUploadAttachmentOptions {
-    /** Entity name */
-    entityName: string;
-    /** Record ID (UUID) */
-    recordId: string;
-    /** Field name of the File-type field */
-    fieldName: string;
-    /**
-     * File to upload. Accepts the native types supported by FormData:
-     * - `Blob` / `File`: standard browser and Node.js ≥ 18 types accepted directly by FormData.
-     *   `File` is a subclass of `Blob` and is typically obtained from a browser file input.
-     * - `Uint8Array`: raw binary buffer (e.g. from `fs.readFileSync` or a Node.js Buffer).
-     *   Converted to a `Blob` internally before appending to FormData.
-     */
-    file: Blob | File | Uint8Array;
     /** Optional expansion level (default: 0) */
     expansionLevel?: number;
 }
@@ -425,6 +408,10 @@ interface EntityUploadAttachmentOptions {
  * Response from uploading an attachment to an entity record
  */
 type EntityUploadAttachmentResponse = Record<string, unknown>;
+/**
+ * Response from deleting an attachment from an entity record
+ */
+type EntityDeleteAttachmentResponse = Record<string, unknown>;
 /**
  * Represents a failure record in an entity operation
  */
@@ -448,6 +435,11 @@ interface EntityOperationResponse {
  * Returns the inserted record with its generated record ID and other fields
  */
 type EntityInsertResponse = EntityRecord;
+/**
+ * Response from updating a single record in an entity
+ * Returns the updated record
+ */
+type EntityUpdateRecordResponse = EntityRecord;
 /**
  * Response from batch inserting data into an entity
  */
@@ -844,9 +836,35 @@ interface EntityServiceModel {
      * @hidden
      */
     batchInsertById(id: string, data: Record<string, any>[], options?: EntityBatchInsertOptions): Promise<EntityBatchInsertResponse>;
+    /**
+     * Updates a single record in an entity by entity ID
+     *
+     * Note: Data Fabric supports trigger events only on individual updates, not on updating multiple records.
+     * Use this method if you need trigger events to fire for the updated record.
+     *
+     * @param entityId - UUID of the entity
+     * @param recordId - UUID of the record to update
+     * @param data - Key-value pairs of fields to update
+     * @param options - Update options
+     * @returns Promise resolving to the updated record
+     * {@link EntityUpdateRecordResponse}
+     * @example
+     * ```typescript
+     * // Basic usage
+     * const result = await entities.updateRecordById(<entityId>, <recordId>, { name: "John Updated", age: 31 });
+     *
+     * // With options
+     * const result = await entities.updateRecordById(<entityId>, <recordId>, { name: "John Updated", age: 31 }, {
+     *   expansionLevel: 1
+     * });
+     * ```
+     */
+    updateRecordById(entityId: string, recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
     /**
      * Updates data in an entity by entity ID
      *
+     * Note: Records updated using updateRecordsById will not trigger Data Fabric trigger events. Use {@link updateRecordById} if you need trigger events to fire for each updated record.
+     *
      * @param id - UUID of the entity
      * @param data - Array of records to update. Each record MUST contain the record Id.
      * @param options - Update options
@@ -901,7 +919,9 @@ interface EntityServiceModel {
     /**
      * Downloads an attachment stored in a File-type field of an entity record.
      *
-     * @param options - Options containing entityName, recordId, and fieldName
+     * @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
      * @returns Promise resolving to Blob containing the file content
      * @example
      * ```typescript
@@ -914,15 +934,19 @@ interface EntityServiceModel {
      * // Get the recordId for the record that contains the attachment
      * const recordId = records.items[0].id;
      *
+     * // Get the entityId from getAll()
+     * const allEntities = await entities.getAll();
+     * const entityId = allEntities[0].id;
+     *
+     * // Get the recordId from getAllRecords()
+     * const records = await entities.getAllRecords(entityId);
+     * const recordId = records[0].id;
+     *
      * // Download attachment using service method
-     * const response = await entities.downloadAttachment({
-     *   entityName: 'Invoice',
-     *   recordId: recordId,
-     *   fieldName: 'Documents'
-     * });
+     * const response = await entities.downloadAttachment(entityId, recordId, 'Documents');
      *
-     * // Or download using entity method
-     * const entity = await entities.getById("<entityId>");
+     * // Or download using entity method (entityId is already known)
+     * const entity = await entities.getById(entityId);
      * const blob = await entity.downloadAttachment(recordId, 'Documents');
      *
      * // Browser: Display Image
@@ -944,43 +968,74 @@ interface EntityServiceModel {
      * fs.writeFileSync('attachment.pdf', buffer);
      * ```
      */
-    downloadAttachment(options: EntityDownloadAttachmentOptions): Promise<Blob>;
+    downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
     /**
      * Uploads an attachment to a File-type field of an entity record.
      *
      * Uses multipart/form-data to upload the file content to the specified field.
      *
-     * @param options - Options containing entityName, recordId, fieldName, file, and optional expansionLevel
-     * @returns Promise resolving to the upload response
-     * {@link EntityUploadAttachmentResponse}
+     * @param entityId - UUID of the entity
+     * @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)
+     * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
      * @example
      * ```typescript
      * import { Entities } from '@uipath/uipath-typescript/entities';
      *
      * const entities = new Entities(sdk);
      *
+     * // Get the entityId from getAll()
+     * const allEntities = await entities.getAll();
+     * const entityId = allEntities[0].id;
+     *
+     * // Get the recordId from getAllRecords()
+     * const records = await entities.getAllRecords(entityId);
+     * const recordId = records[0].id;
+     *
      * // Browser: Upload a file from an input element
      * const fileInput = document.getElementById('file-input') as HTMLInputElement;
      * const file = fileInput.files[0];
-     * const response = await entities.uploadAttachment({
-     *   entityName: 'Invoice',
-     *   recordId: '<recordId>',
-     *   fieldName: 'Documents',
-     *   file: file
-     * });
+     * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
      *
      * // Node.js: Upload a file from disk
      * const fileBuffer = fs.readFileSync('document.pdf');
      * const blob = new Blob([fileBuffer], { type: 'application/pdf' });
-     * const response = await entities.uploadAttachment({
-     *   entityName: 'Invoice',
-     *   recordId: '<recordId>',
-     *   fieldName: 'Documents',
-     *   file: blob
-     * });
+     * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', blob);
      * ```
      */
-    uploadAttachment(options: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
+    uploadAttachment(entityId: string, recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
+    /**
+     * Removes an attachment from 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
+     * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
+     * @example
+     * ```typescript
+     * import { Entities } from '@uipath/uipath-typescript/entities';
+     *
+     * const entities = new Entities(sdk);
+     *
+     * // Get the entityId from getAll()
+     * const allEntities = await entities.getAll();
+     * const entityId = allEntities[0].id;
+     *
+     * // Get the recordId from getAllRecords()
+     * const records = await entities.getAllRecords(entityId);
+     * const recordId = records[0].id;
+     *
+     * // Delete attachment for a specific record and field
+     * await entities.deleteAttachment(entityId, recordId, 'Documents');
+     *
+     * // Or delete using entity method (entityId is already known)
+     * const entity = await entities.getById(entityId);
+     * await entity.deleteAttachment(recordId, 'Documents');
+     * ```
+     */
+    deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
 }
 /**
  * Entity methods interface - defines operations that can be performed on an entity
@@ -1008,9 +1063,24 @@ interface EntityMethods {
      * @returns Promise resolving to batch insert response
      */
     insertRecords(data: Record<string, any>[], options?: EntityInsertRecordsOptions): Promise<EntityBatchInsertResponse>;
+    /**
+     * Update a single record in this entity
+     *
+     * Note: Data Fabric supports trigger events only on individual updates, not on updating multiple records.
+     * Use this method if you need trigger events to fire for the updated record.
+     *
+     * @param recordId - UUID of the record to update
+     * @param data - Key-value pairs of fields to update
+     * @param options - Update options
+     * @returns Promise resolving to the updated record
+     */
+    updateRecord(recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
     /**
      * Update data in this entity
      *
+     * Note: Records updated using updateRecords will not trigger Data Fabric trigger events. Use {@link updateRecord} if you need
+     * trigger events to fire for each updated record.
+     *
      * @param data - Array of records to update. Each record MUST contain the record Id,
      *               otherwise the update will fail.
      * @param options - Update options
@@ -1054,10 +1124,18 @@ interface EntityMethods {
      * @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 expansionLevel - Optional expansion level (default: 0)
-     * @returns Promise resolving to the upload response
+     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. expansionLevel)
+     * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
+     */
+    uploadAttachment(recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
+    /**
+     * Deletes an attachment from a File-type field of an entity record
+     *
+     * @param recordId - UUID of the record containing the attachment
+     * @param fieldName - Name of the File-type field containing the attachment
+     * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
      */
-    uploadAttachment(recordId: string, fieldName: string, file: Blob | File | Uint8Array, expansionLevel?: number): Promise<EntityUploadAttachmentResponse>;
+    deleteAttachment(recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
     /**
      * @deprecated Use {@link insertRecord} instead.
      * @hidden
@@ -1238,6 +1316,31 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * ```
      */
     insertRecordsById(id: string, data: Record<string, any>[], options?: EntityInsertRecordsOptions): Promise<EntityBatchInsertResponse>;
+    /**
+     * Updates a single record in an entity by entity ID
+     *
+     * @param entityId - UUID of the entity
+     * @param recordId - UUID of the record to update
+     * @param data - Key-value pairs of fields to update
+     * @param options - Update options
+     * @returns Promise resolving to the updated record
+     *
+     * @example
+     * ```typescript
+     * import { Entities } from '@uipath/uipath-typescript/entities';
+     *
+     * const entities = new Entities(sdk);
+     *
+     * // Basic usage
+     * const result = await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated", age: 31 });
+     *
+     * // With options
+     * const result = await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated", age: 31 }, {
+     *   expansionLevel: 1
+     * });
+     * ```
+     */
+    updateRecordById(entityId: string, recordId: string, data: Record<string, any>, options?: EntityUpdateRecordOptions): Promise<EntityUpdateRecordResponse>;
     /**
      * Updates data in an entity by entity ID
      *
@@ -1313,7 +1416,9 @@ declare class EntityService extends BaseService implements EntityServiceModel {
     /**
      * Downloads an attachment from an entity record field
      *
-     * @param options - Options containing entityName, recordId, and fieldName
+     * @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
      * @returns Promise resolving to Blob containing the file content
      *
      * @example
@@ -1322,19 +1427,28 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *
      * const entities = new Entities(sdk);
      *
+     * // Get the entityId from getAll()
+     * const allEntities = await entities.getAll();
+     * const entityId = allEntities[0].id;
+     *
+     * // Get the recordId from getAllRecords()
+     * const records = await entities.getAllRecords(entityId);
+     * const recordId = records[0].id;
+     *
      * // Download attachment for a specific record and field
-     * const blob = await entities.downloadAttachment({
-     *   entityName: 'Invoice',
-     *   recordId: '<record-uuid>',
-     *   fieldName: 'Documents'
-     * });
+     * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents');
+     * ```
      */
-    downloadAttachment(options: EntityDownloadAttachmentOptions): Promise<Blob>;
+    downloadAttachment(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
     /**
      * Uploads an attachment to a File-type field of an entity record
      *
-     * @param options - Options containing entityName, recordId, fieldName, file, and optional expansionLevel
-     * @returns Promise resolving to the upload response
+     * @param entityId - UUID of the entity
+     * @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)
+     * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
      *
      * @example
      * ```typescript
@@ -1342,16 +1456,46 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      *
      * const entities = new Entities(sdk);
      *
+     * // Get the entityId from getAll()
+     * const allEntities = await entities.getAll();
+     * const entityId = allEntities[0].id;
+     *
+     * // Get the recordId from getAllRecords()
+     * const records = await entities.getAllRecords(entityId);
+     * const recordId = records[0].id;
+     *
      * // Upload a file attachment
-     * const response = await entities.uploadAttachment({
-     *   entityName: 'Invoice',
-     *   recordId: '<record-uuid>',
-     *   fieldName: 'Documents',
-     *   file: file
-     * });
+     * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
+     * ```
+     */
+    uploadAttachment(entityId: string, recordId: string, fieldName: string, file: EntityFileType, options?: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
+    /**
+     * Removes an attachment from 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
+     * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
+     *
+     * @example
+     * ```typescript
+     * import { Entities } from '@uipath/uipath-typescript/entities';
+     *
+     * const entities = new Entities(sdk);
+     *
+     * // Get the entityId from getAll()
+     * const allEntities = await entities.getAll();
+     * const entityId = allEntities[0].id;
+     *
+     * // Get the recordId from getAllRecords()
+     * const records = await entities.getAllRecords(entityId);
+     * const recordId = records[0].id;
+     *
+     * // Delete attachment for a specific record and field
+     * await entities.deleteAttachment(entityId, recordId, 'Documents');
      * ```
      */
-    uploadAttachment(options: EntityUploadAttachmentOptions): Promise<EntityUploadAttachmentResponse>;
+    deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
     /**
    * @hidden
    * @deprecated Use {@link getAllRecords} instead.
@@ -1603,4 +1747,4 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
 }
 
 export { ChoiceSetService, ChoiceSetService as ChoiceSets, DataDirectionType, EntityService as Entities, EntityFieldDataType, EntityService, EntityType, FieldDisplayType, JoinType, ReferenceType, createEntityWithMethods };
-export type { ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityDownloadAttachmentOptions, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityRecord, EntityServiceModel, EntityUpdateOptions, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, RawEntityGetResponse, SourceJoinCriteria };
+export type { ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityRecord, EntityServiceModel, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, RawEntityGetResponse, SourceJoinCriteria };