@uipath/uipath-typescript 1.2.0 → 1.2.2

package/dist/entities/index.d.ts

@@ -358,25 +358,35 @@ interface EntityInsertOptions {
 /**
  * Options for inserting a single record into an entity
  */
-type EntityInsertRecordOptions = EntityInsertOptions;
+interface EntityInsertRecordOptions extends EntityInsertOptions {
+}
 /**
  * Options for batch inserting data into an entity
  * @deprecated Use {@link EntityInsertRecordsOptions} instead for better clarity on inserting multiple records into an entity. This type will be removed in future versions.
  */
-type EntityBatchInsertOptions = EntityOperationOptions;
+interface EntityBatchInsertOptions extends EntityOperationOptions {
+}
 /**
  * Options for inserting multiple records into an entity
  */
-type EntityInsertRecordsOptions = EntityOperationOptions;
+interface EntityInsertRecordsOptions extends EntityOperationOptions {
+}
+/**
+ * Options for updating a single record in an entity
+ */
+interface EntityUpdateRecordOptions extends 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;
+interface EntityUpdateOptions extends EntityOperationOptions {
+}
 /**
  * Options for updating data in an entity
  */
-type EntityUpdateRecordsOptions = EntityOperationOptions;
+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.
@@ -388,7 +398,8 @@ interface EntityDeleteOptions {
 /**
  * Options for deleting records in an entity
  */
-type EntityDeleteRecordsOptions = EntityDeleteOptions;
+interface EntityDeleteRecordsOptions extends EntityDeleteOptions {
+}
 /**
  * Supported file types for attachment upload
  */
@@ -427,22 +438,32 @@ interface EntityOperationResponse {
     failureRecords: FailureRecord[];
 }
 /**
- * Response from inserting a single record into an entity
- * Returns the inserted record with its generated record ID and other fields
+ * Response from inserting a single record into an entity.
+ * Returns the inserted record with its generated record ID and other fields.
  */
-type EntityInsertResponse = EntityRecord;
+interface EntityInsertResponse extends EntityRecord {
+}
+/**
+ * Response from updating a single record in an entity.
+ * Returns the updated record.
+ */
+interface EntityUpdateRecordResponse extends EntityRecord {
+}
 /**
  * Response from batch inserting data into an entity
  */
-type EntityBatchInsertResponse = EntityOperationResponse;
+interface EntityBatchInsertResponse extends EntityOperationResponse {
+}
 /**
  * Response from updating data in an entity
  */
-type EntityUpdateResponse = EntityOperationResponse;
+interface EntityUpdateResponse extends EntityOperationResponse {
+}
 /**
  * Response from deleting data from an entity
  */
-type EntityDeleteResponse = EntityOperationResponse;
+interface EntityDeleteResponse extends EntityOperationResponse {
+}
 /**
  * Entity type enum
  */
@@ -827,11 +848,37 @@ 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 data - Array of records to update. Each record MUST contain the record id.
      * @param options - Update options
      * @returns Promise resolving to update response
      * {@link EntityUpdateResponse}
@@ -839,14 +886,14 @@ interface EntityServiceModel {
      * ```typescript
      * // Basic usage
      * const result = await entities.updateRecordsById(<entityId>, [
-     *   { Id: "123", name: "John Updated", age: 31 },
-     *   { Id: "456", name: "Jane Updated", age: 26 }
+     *   { id: "123", name: "John Updated", age: 31 },
+     *   { id: "456", name: "Jane Updated", age: 26 }
      * ]);
      *
      * // With options
      * const result = await entities.updateRecordsById(<entityId>, [
-     *   { Id: "123", name: "John Updated", age: 31 },
-     *   { Id: "456", name: "Jane Updated", age: 26 }
+     *   { id: "123", name: "John Updated", age: 31 },
+     *   { id: "456", name: "Jane Updated", age: 26 }
      * ], {
      *   expansionLevel: 1,
      *   failOnFirst: true
@@ -1028,9 +1075,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
@@ -1266,6 +1328,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
      *
@@ -1672,4 +1759,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, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFileType, 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 };

package/dist/entities/index.mjs

@@ -1647,6 +1647,13 @@ function createEntityMethods(entityData, service) {
                 throw new Error('Entity ID is undefined');
             return service.insertRecordsById(entityData.id, data, options);
         },
+        async updateRecord(recordId, data, options) {
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            if (!recordId)
+                throw new Error('Record ID is undefined');
+            return service.updateRecordById(entityData.id, recordId, data, options);
+        },
         async updateRecords(data, options) {
             if (!entityData.id)
                 throw new Error('Entity ID is undefined');
@@ -1732,6 +1739,7 @@ const DATA_FABRIC_ENDPOINTS = {
         GET_RECORD_BY_ID: (entityId, recordId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/read/${recordId}`,
         INSERT_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/insert`,
         BATCH_INSERT_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/insert-batch`,
+        UPDATE_RECORD_BY_ID: (entityId, recordId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/update/${recordId}`,
         UPDATE_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/update-batch`,
         DELETE_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/delete-batch`,
         DOWNLOAD_ATTACHMENT: (entityId, recordId, fieldName) => `${DATAFABRIC_BASE}/api/Attachment/entity/${entityId}/${recordId}/${fieldName}`,
@@ -1893,7 +1901,7 @@ const EntityFieldTypeMap = {
 // Connection string placeholder that will be replaced during build
 const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
 // SDK Version placeholder 
-const SDK_VERSION = "1.2.0";
+const SDK_VERSION = "1.2.2";
 const VERSION = "Version";
 const SERVICE = "Service";
 const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -2360,6 +2368,42 @@ class EntityService extends BaseService {
         const camelResponse = pascalToCamelCaseKeys(response.data);
         return camelResponse;
     }
+    /**
+     * 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
+     * });
+     * ```
+     */
+    async updateRecordById(entityId, recordId, data, options = {}) {
+        const params = createParams({
+            expansionLevel: options.expansionLevel
+        });
+        const response = await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPDATE_RECORD_BY_ID(entityId, recordId), data, {
+            params,
+            ...options
+        });
+        // Convert PascalCase response to camelCase
+        const camelResponse = pascalToCamelCaseKeys(response.data);
+        return camelResponse;
+    }
     /**
      * Updates data in an entity by entity ID
      *
@@ -2691,6 +2735,9 @@ __decorate([
 __decorate([
     track('Entities.InsertRecordsById')
 ], EntityService.prototype, "insertRecordsById", null);
+__decorate([
+    track('Entities.UpdateRecordById')
+], EntityService.prototype, "updateRecordById", null);
 __decorate([
     track('Entities.UpdateRecordsById')
 ], EntityService.prototype, "updateRecordsById", null);