@uipath/uipath-typescript 1.1.3 → 1.2.1

package/dist/entities/index.cjs

@@ -546,11 +546,8 @@ class ApiClient {
         return this.tokenManager.getValidToken();
     }
     async getDefaultHeaders() {
-        // Get headers from execution context first
-        const contextHeaders = this.executionContext.getHeaders();
         const token = await this.getValidToken();
         return {
-            ...contextHeaders,
             'Authorization': `Bearer ${token}`,
             'Content-Type': CONTENT_TYPES.JSON,
             ...this.defaultHeaders,
@@ -1652,6 +1649,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');
@@ -1675,24 +1679,19 @@ function createEntityMethods(entityData, service) {
             return service.getRecordById(entityData.id, recordId, options);
         },
         async downloadAttachment(recordId, fieldName) {
-            if (!entityData.name)
-                throw new Error('Entity name is undefined');
-            return service.downloadAttachment({
-                entityName: entityData.name,
-                recordId,
-                fieldName
-            });
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            return service.downloadAttachment(entityData.id, recordId, fieldName);
         },
-        async uploadAttachment(recordId, fieldName, file, expansionLevel) {
-            if (!entityData.name)
-                throw new Error('Entity name is undefined');
-            return service.uploadAttachment({
-                entityName: entityData.name,
-                recordId,
-                fieldName,
-                file,
-                expansionLevel
-            });
+        async uploadAttachment(recordId, fieldName, file, options) {
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            return service.uploadAttachment(entityData.id, recordId, fieldName, file, options);
+        },
+        async deleteAttachment(recordId, fieldName) {
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            return service.deleteAttachment(entityData.id, recordId, fieldName);
         },
         async insert(data, options) {
             return this.insertRecord(data, options);
@@ -1742,10 +1741,12 @@ 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: (entityName, recordId, fieldName) => `${DATAFABRIC_BASE}/api/Attachment/${entityName}/${recordId}/${fieldName}`,
-        UPLOAD_ATTACHMENT: (entityName, recordId, fieldName) => `${DATAFABRIC_BASE}/api/Attachment/${entityName}/${recordId}/${fieldName}`,
+        DOWNLOAD_ATTACHMENT: (entityId, recordId, fieldName) => `${DATAFABRIC_BASE}/api/Attachment/entity/${entityId}/${recordId}/${fieldName}`,
+        UPLOAD_ATTACHMENT: (entityId, recordId, fieldName) => `${DATAFABRIC_BASE}/api/Attachment/entity/${entityId}/${recordId}/${fieldName}`,
+        DELETE_ATTACHMENT: (entityId, recordId, fieldName) => `${DATAFABRIC_BASE}/api/Attachment/entity/${entityId}/${recordId}/${fieldName}`,
     },
     CHOICESETS: {
         GET_ALL: `${DATAFABRIC_BASE}/api/Entity/choiceset`,
@@ -1902,7 +1903,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.1.3";
+const SDK_VERSION = "1.2.1";
 const VERSION = "Version";
 const SERVICE = "Service";
 const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -2369,6 +2370,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
      *
@@ -2478,7 +2515,9 @@ class EntityService extends BaseService {
     /**
      * 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
@@ -2487,16 +2526,20 @@ class EntityService extends BaseService {
      *
      * 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');
+     * ```
      */
-    async downloadAttachment(options) {
-        const { entityName, recordId, fieldName } = options;
-        const response = await this.get(DATA_FABRIC_ENDPOINTS.ENTITY.DOWNLOAD_ATTACHMENT(entityName, recordId, fieldName), {
+    async downloadAttachment(entityId, recordId, fieldName) {
+        const response = await this.get(DATA_FABRIC_ENDPOINTS.ENTITY.DOWNLOAD_ATTACHMENT(entityId, recordId, fieldName), {
             responseType: RESPONSE_TYPES.BLOB
         });
         return response.data;
@@ -2504,8 +2547,12 @@ class EntityService extends BaseService {
     /**
      * 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
@@ -2513,17 +2560,19 @@ class EntityService extends BaseService {
      *
      * 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);
      * ```
      */
-    async uploadAttachment(options) {
-        const { entityName, recordId, fieldName, file, expansionLevel } = options;
+    async uploadAttachment(entityId, recordId, fieldName, file, options) {
         const formData = new FormData();
         if (file instanceof Uint8Array) {
             formData.append('file', new Blob([file.buffer]));
@@ -2531,12 +2580,42 @@ class EntityService extends BaseService {
         else {
             formData.append('file', file);
         }
-        const params = createParams({ expansionLevel });
-        const response = await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPLOAD_ATTACHMENT(entityName, recordId, fieldName), formData, { params });
+        const params = createParams({ expansionLevel: options?.expansionLevel });
+        const response = await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPLOAD_ATTACHMENT(entityId, recordId, fieldName), formData, { params });
         // Convert PascalCase response to camelCase
         const camelResponse = pascalToCamelCaseKeys(response.data);
         return camelResponse;
     }
+    /**
+     * 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');
+     * ```
+     */
+    async deleteAttachment(entityId, recordId, fieldName) {
+        const response = await this.delete(DATA_FABRIC_ENDPOINTS.ENTITY.DELETE_ATTACHMENT(entityId, recordId, fieldName));
+        return response.data;
+    }
     /**
    * @hidden
    * @deprecated Use {@link getAllRecords} instead.
@@ -2658,6 +2737,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);
@@ -2673,6 +2755,9 @@ __decorate([
 __decorate([
     track('Entities.UploadAttachment')
 ], EntityService.prototype, "uploadAttachment", null);
+__decorate([
+    track('Entities.DeleteAttachment')
+], EntityService.prototype, "deleteAttachment", null);
 
 class ChoiceSetService extends BaseService {
     /**