@uipath/uipath-typescript 1.1.2 → 1.2.0

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,
@@ -562,8 +559,13 @@ class ApiClient {
         const normalizedPath = path.startsWith('/') ? path.substring(1) : path;
         // Construct URL with org and tenant names
         const url = new URL(`${this.config.orgName}/${this.config.tenantName}/${normalizedPath}`, this.config.baseUrl).toString();
+        const isFormData = options.body instanceof FormData;
+        const defaultHeaders = await this.getDefaultHeaders();
+        if (isFormData) {
+            delete defaultHeaders['Content-Type'];
+        }
         const headers = {
-            ...await this.getDefaultHeaders(),
+            ...defaultHeaders,
             ...options.headers
         };
         // Convert params to URLSearchParams
@@ -574,11 +576,15 @@ class ApiClient {
             });
         }
         const fullUrl = searchParams.toString() ? `${url}?${searchParams.toString()}` : url;
+        let body = undefined;
+        if (options.body) {
+            body = isFormData ? options.body : JSON.stringify(options.body);
+        }
         try {
             const response = await fetch(fullUrl, {
                 method,
                 headers,
-                body: options.body ? JSON.stringify(options.body) : undefined,
+                body,
                 signal: options.signal
             });
             if (!response.ok) {
@@ -1666,13 +1672,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, 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);
@@ -1724,7 +1736,9 @@ const DATA_FABRIC_ENDPOINTS = {
         BATCH_INSERT_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/insert-batch`,
         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}`,
+        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`,
@@ -1881,7 +1895,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.2";
+const SDK_VERSION = "1.2.0";
 const VERSION = "Version";
 const SERVICE = "Service";
 const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -2457,7 +2471,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
@@ -2466,20 +2482,96 @@ 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;
     }
+    /**
+     * Uploads an attachment to a File-type field of an entity record
+     *
+     * @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;
+     *
+     * // Upload a file attachment
+     * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
+     * ```
+     */
+    async uploadAttachment(entityId, recordId, fieldName, file, options) {
+        const formData = new FormData();
+        if (file instanceof Uint8Array) {
+            formData.append('file', new Blob([file.buffer]));
+        }
+        else {
+            formData.append('file', file);
+        }
+        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.
@@ -2613,6 +2705,12 @@ __decorate([
 __decorate([
     track('Entities.DownloadAttachment')
 ], EntityService.prototype, "downloadAttachment", null);
+__decorate([
+    track('Entities.UploadAttachment')
+], EntityService.prototype, "uploadAttachment", null);
+__decorate([
+    track('Entities.DeleteAttachment')
+], EntityService.prototype, "deleteAttachment", null);
 
 class ChoiceSetService extends BaseService {
     /**

package/dist/entities/index.d.ts

@@ -390,16 +390,24 @@ interface EntityDeleteOptions {
  */
 type EntityDeleteRecordsOptions = EntityDeleteOptions;
 /**
- * Options for downloading an attachment from an entity record
- */
-interface EntityDownloadAttachmentOptions {
-    /** Entity name */
-    entityName: string;
-    /** Record ID */
-    recordId: string;
-    /** Field name containing the attachment */
-    fieldName: string;
+ * Supported file types for attachment upload
+ */
+type EntityFileType = Blob | File | Uint8Array;
+/**
+ * Optional options for uploading an attachment to an entity record
+ */
+interface EntityUploadAttachmentOptions {
+    /** Optional expansion level (default: 0) */
+    expansionLevel?: number;
 }
+/**
+ * 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
  */
@@ -876,7 +884,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
@@ -889,15 +899,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
@@ -919,7 +933,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 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(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(entityId, recordId, 'Documents', blob);
+     * ```
+     */
+    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
@@ -987,6 +1068,24 @@ interface EntityMethods {
      * @returns Promise resolving to Blob containing the file content
      */
     downloadAttachment(recordId: string, fieldName: string): 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)
+     * @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}
+     */
+    deleteAttachment(recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
     /**
      * @deprecated Use {@link insertRecord} instead.
      * @hidden
@@ -1242,7 +1341,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
@@ -1251,14 +1352,75 @@ 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(entityId: string, recordId: string, fieldName: string): Promise<Blob>;
+    /**
+     * Uploads an attachment to a File-type field of an entity record
+     *
+     * @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;
+     *
+     * // Upload a file attachment
+     * 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');
+     * ```
      */
-    downloadAttachment(options: EntityDownloadAttachmentOptions): Promise<Blob>;
+    deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
     /**
    * @hidden
    * @deprecated Use {@link getAllRecords} instead.
@@ -1510,4 +1672,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, 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, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, RawEntityGetResponse, SourceJoinCriteria };