@uipath/uipath-typescript 1.3.0 → 1.3.1

package/dist/index.cjs

@@ -4573,6 +4573,12 @@ const MAESTRO_ENDPOINTS = {
 /**
  * Data Fabric Service Endpoints
  */
+/**
+ * Default folder key used for tenant-level Data Fabric entities.
+ * Tenant-level entities are not scoped to a folder; this is the
+ * conventional placeholder value the API expects.
+ */
+const DATA_FABRIC_TENANT_FOLDER_ID = '00000000-0000-0000-0000-000000000000';
 /**
  * Data Fabric Entity Service Endpoints
  */
@@ -4587,6 +4593,11 @@ const DATA_FABRIC_ENDPOINTS = {
         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`,
+        UPSERT: `${DATAFABRIC_BASE}/api/Entity`,
+        DELETE: (entityId) => `${DATAFABRIC_BASE}/api/Entity/${entityId}`,
+        UPDATE_METADATA: (entityId) => `${DATAFABRIC_BASE}/api/Entity/${entityId}/metadata`,
+        QUERY_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/query`,
+        BULK_UPLOAD_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/bulk-upload`,
         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}`,
@@ -5420,7 +5431,7 @@ function normalizeBaseUrl(url) {
 // 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.3.0";
+const SDK_VERSION = "1.3.1";
 const VERSION = "Version";
 const SERVICE = "Service";
 const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -5809,7 +5820,7 @@ var _UiPath_instances, _UiPath_config, _UiPath_authService, _UiPath_initialized,
  *
  * Supports two usage patterns:
  * 1. Full config in constructor — for server-side or explicit configuration
- * 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps plugin
+ * 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps-dev plugin
  *
  * @example
  * ```typescript
@@ -6275,15 +6286,11 @@ const RESPONSE_TYPES = {
 
 class ApiClient {
     constructor(config, executionContext, tokenManager, clientConfig = {}) {
-        this.defaultHeaders = {};
         this.config = config;
         this.executionContext = executionContext;
         this.clientConfig = clientConfig;
         this.tokenManager = tokenManager;
     }
-    setDefaultHeaders(headers) {
-        this.defaultHeaders = { ...this.defaultHeaders, ...headers };
-    }
     /**
      * Gets a valid authentication token, refreshing if necessary.
      * Used internally for API requests and exposed for services that need manual auth headers.
@@ -6299,7 +6306,6 @@ class ApiClient {
         return {
             'Authorization': `Bearer ${token}`,
             'Content-Type': CONTENT_TYPES.JSON,
-            ...this.defaultHeaders,
             ...this.clientConfig.headers
         };
     }
@@ -7355,6 +7361,8 @@ class BaseService {
      *
      * @param instance - UiPath SDK instance providing authentication and configuration.
      *                    Services receive this via dependency injection in the modular pattern.
+     * @param headers - Optional default headers to include in every request (e.g. `x-uipath-external-user-id` for
+     *                  CAS external-app auth)
      *
      * @example
      * ```typescript
@@ -7374,11 +7382,11 @@ class BaseService {
      * const entities = new Entities(sdk);
      * ```
      */
-    constructor(instance) {
+    constructor(instance, headers) {
         // Private field - not visible via Object.keys() or any reflection
         _BaseService_apiClient.set(this, void 0);
         const { config, context, tokenManager } = SDKInternalsRegistry.get(instance);
-        __classPrivateFieldSet(this, _BaseService_apiClient, new ApiClient(config, context, tokenManager), "f");
+        __classPrivateFieldSet(this, _BaseService_apiClient, new ApiClient(config, context, tokenManager, headers ? { headers } : {}), "f");
     }
     /**
      * Gets a valid authentication token, refreshing if necessary.
@@ -7637,27 +7645,41 @@ function createEntityMethods(entityData, service) {
                 throw new Error('Entity ID is undefined');
             return service.deleteAttachment(entityData.id, recordId, fieldName);
         },
+        async queryRecords(options) {
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            return service.queryRecordsById(entityData.id, options);
+        },
+        async importRecords(file) {
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            return service.importRecordsById(entityData.id, file);
+        },
         async insert(data, options) {
             return this.insertRecord(data, options);
         },
         async batchInsert(data, options) {
             return this.insertRecords(data, options);
         },
-        async update(data, options) {
-            return this.updateRecords(data, options);
-        },
-        async delete(recordIds, options) {
-            return this.deleteRecords(recordIds, options);
-        },
         async getRecords(options) {
             return this.getAllRecords(options);
-        }
+        },
+        async delete() {
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            return service.deleteById(entityData.id);
+        },
+        async update(options) {
+            if (!entityData.id)
+                throw new Error('Entity ID is undefined');
+            return service.updateById(entityData.id, options);
+        },
     };
 }
 /**
- * Creates an actionable entity metadata by combining entity with operational methods
+ * Creates an actionable entity by combining entity metadata with data and management methods
  *
- * @param entityData - Entity metadata
+ * @param entityMetadata - Entity metadata
  * @param service - The entity service instance
  * @returns Entity metadata with added methods
  */
@@ -7667,42 +7689,7 @@ function createEntityWithMethods(entityData, service) {
 }
 
 /**
- * Creates query parameters object from key-value pairs, filtering out undefined values
- * @param paramsObj - Object containing parameter key-value pairs
- * @returns Parameters object with undefined values filtered out
- *
- * @example
- * ```typescript
- * // Entity service parameters
- * const params = createParams({
- *   start: 0,
- *   limit: 10,
- *   expansionLevel: 1
- * });
- *
- * // With optional/undefined values (automatically filtered)
- * const params = createParams({
- *   start: options.start,        // Could be undefined
- *   limit: options.limit,        // Could be undefined
- *   expansionLevel: options.expansionLevel  // Could be undefined
- * });
- *
- * // Empty params
- * const params = createParams();
- * ```
- */
-function createParams(paramsObj = {}) {
-    const params = {};
-    for (const [key, value] of Object.entries(paramsObj)) {
-        if (value !== undefined && value !== null) {
-            params[key] = value;
-        }
-    }
-    return params;
-}
-
-/**
- * Entity field type names
+ * Entity field data type names (SQL-level types returned by the API)
  */
 exports.EntityFieldDataType = void 0;
 (function (EntityFieldDataType) {
@@ -7718,7 +7705,41 @@ exports.EntityFieldDataType = void 0;
     EntityFieldDataType["BOOLEAN"] = "BOOLEAN";
     EntityFieldDataType["BIG_INTEGER"] = "BIG_INTEGER";
     EntityFieldDataType["MULTILINE_TEXT"] = "MULTILINE_TEXT";
+    EntityFieldDataType["FILE"] = "FILE";
+    EntityFieldDataType["CHOICE_SET_SINGLE"] = "CHOICE_SET_SINGLE";
+    EntityFieldDataType["CHOICE_SET_MULTIPLE"] = "CHOICE_SET_MULTIPLE";
+    EntityFieldDataType["AUTO_NUMBER"] = "AUTO_NUMBER";
+    EntityFieldDataType["RELATIONSHIP"] = "RELATIONSHIP";
 })(exports.EntityFieldDataType || (exports.EntityFieldDataType = {}));
+/**
+ * Logical operator for combining query filter groups
+ */
+exports.LogicalOperator = void 0;
+(function (LogicalOperator) {
+    /** Combine conditions with AND — all conditions must match */
+    LogicalOperator[LogicalOperator["And"] = 0] = "And";
+    /** Combine conditions with OR — any condition must match */
+    LogicalOperator[LogicalOperator["Or"] = 1] = "Or";
+})(exports.LogicalOperator || (exports.LogicalOperator = {}));
+/**
+ * Comparison operators for entity query filters.
+ * Not all operators are valid for all field types.
+ */
+exports.QueryFilterOperator = void 0;
+(function (QueryFilterOperator) {
+    QueryFilterOperator["Equals"] = "=";
+    QueryFilterOperator["NotEquals"] = "!=";
+    QueryFilterOperator["GreaterThan"] = ">";
+    QueryFilterOperator["LessThan"] = "<";
+    QueryFilterOperator["GreaterThanOrEqual"] = ">=";
+    QueryFilterOperator["LessThanOrEqual"] = "<=";
+    QueryFilterOperator["Contains"] = "contains";
+    QueryFilterOperator["NotContains"] = "not contains";
+    QueryFilterOperator["StartsWith"] = "startswith";
+    QueryFilterOperator["EndsWith"] = "endswith";
+    QueryFilterOperator["In"] = "in";
+    QueryFilterOperator["NotIn"] = "not in";
+})(exports.QueryFilterOperator || (exports.QueryFilterOperator = {}));
 /**
  * Entity type enum
  */
@@ -7764,6 +7785,41 @@ exports.JoinType = void 0;
     JoinType["LeftJoin"] = "LeftJoin";
 })(exports.JoinType || (exports.JoinType = {}));
 
+/**
+ * Creates query parameters object from key-value pairs, filtering out undefined values
+ * @param paramsObj - Object containing parameter key-value pairs
+ * @returns Parameters object with undefined values filtered out
+ *
+ * @example
+ * ```typescript
+ * // Entity service parameters
+ * const params = createParams({
+ *   start: 0,
+ *   limit: 10,
+ *   expansionLevel: 1
+ * });
+ *
+ * // With optional/undefined values (automatically filtered)
+ * const params = createParams({
+ *   start: options.start,        // Could be undefined
+ *   limit: options.limit,        // Could be undefined
+ *   expansionLevel: options.expansionLevel  // Could be undefined
+ * });
+ *
+ * // Empty params
+ * const params = createParams();
+ * ```
+ */
+function createParams(paramsObj = {}) {
+    const params = {};
+    for (const [key, value] of Object.entries(paramsObj)) {
+        if (value !== undefined && value !== null) {
+            params[key] = value;
+        }
+    }
+    return params;
+}
+
 /**
  * Entity field data types (SQL types from API)
  */
@@ -7782,6 +7838,7 @@ var SqlFieldType;
     SqlFieldType["DECIMAL"] = "DECIMAL";
     SqlFieldType["MULTILINE"] = "MULTILINE";
 })(SqlFieldType || (SqlFieldType = {}));
+
 /**
  * Maps fields for Entities
  */
@@ -7791,6 +7848,40 @@ const EntityMap = {
     sqlType: 'fieldDataType',
     fieldDefinition: 'fieldMetaData'
 };
+/**
+ * Maps EntityFieldDataType values to the API field payload components for create/update operations
+ */
+const EntitySchemaFieldTypeMap = {
+    [exports.EntityFieldDataType.UUID]: { sqlTypeName: SqlFieldType.UNIQUEIDENTIFIER, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.STRING]: { sqlTypeName: SqlFieldType.NVARCHAR, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.INTEGER]: { sqlTypeName: SqlFieldType.INT, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.DATETIME]: { sqlTypeName: SqlFieldType.DATETIME2, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.DATETIME_WITH_TZ]: { sqlTypeName: SqlFieldType.DATETIMEOFFSET, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.DECIMAL]: { sqlTypeName: SqlFieldType.DECIMAL, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.FLOAT]: { sqlTypeName: SqlFieldType.FLOAT, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.DOUBLE]: { sqlTypeName: SqlFieldType.REAL, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.DATE]: { sqlTypeName: SqlFieldType.DATE, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.BOOLEAN]: { sqlTypeName: SqlFieldType.BIT, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.BIG_INTEGER]: { sqlTypeName: SqlFieldType.BIGINT, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.MULTILINE_TEXT]: { sqlTypeName: SqlFieldType.MULTILINE, fieldDisplayType: exports.FieldDisplayType.Basic },
+    [exports.EntityFieldDataType.FILE]: { sqlTypeName: SqlFieldType.UNIQUEIDENTIFIER, fieldDisplayType: exports.FieldDisplayType.File },
+    [exports.EntityFieldDataType.CHOICE_SET_SINGLE]: { sqlTypeName: SqlFieldType.INT, fieldDisplayType: exports.FieldDisplayType.ChoiceSetSingle },
+    [exports.EntityFieldDataType.CHOICE_SET_MULTIPLE]: { sqlTypeName: SqlFieldType.NVARCHAR, fieldDisplayType: exports.FieldDisplayType.ChoiceSetMultiple },
+    [exports.EntityFieldDataType.AUTO_NUMBER]: { sqlTypeName: SqlFieldType.DECIMAL, fieldDisplayType: exports.FieldDisplayType.AutoNumber },
+    [exports.EntityFieldDataType.RELATIONSHIP]: { sqlTypeName: SqlFieldType.UNIQUEIDENTIFIER, fieldDisplayType: exports.FieldDisplayType.Relationship },
+};
+/**
+ * Maps FieldDisplayType values to EntityFieldDataType for types that share SQL types
+ * with other field types (File, ChoiceSetSingle, ChoiceSetMultiple, AutoNumber).
+ * Used during read-side transformation to produce the correct EntityFieldDataType.
+ */
+const FieldDisplayTypeToDataType = {
+    [exports.FieldDisplayType.File]: exports.EntityFieldDataType.FILE,
+    [exports.FieldDisplayType.ChoiceSetSingle]: exports.EntityFieldDataType.CHOICE_SET_SINGLE,
+    [exports.FieldDisplayType.ChoiceSetMultiple]: exports.EntityFieldDataType.CHOICE_SET_MULTIPLE,
+    [exports.FieldDisplayType.AutoNumber]: exports.EntityFieldDataType.AUTO_NUMBER,
+    [exports.FieldDisplayType.Relationship]: exports.EntityFieldDataType.RELATIONSHIP,
+};
 /**
  * Maps SQL field types to friendly display names
  */
@@ -7806,7 +7897,7 @@ const EntityFieldTypeMap = {
     [SqlFieldType.DATE]: exports.EntityFieldDataType.DATE,
     [SqlFieldType.BIT]: exports.EntityFieldDataType.BOOLEAN,
     [SqlFieldType.DECIMAL]: exports.EntityFieldDataType.DECIMAL,
-    [SqlFieldType.MULTILINE]: exports.EntityFieldDataType.MULTILINE_TEXT
+    [SqlFieldType.MULTILINE]: exports.EntityFieldDataType.MULTILINE_TEXT,
 };
 
 /**
@@ -8136,6 +8227,99 @@ class EntityService extends BaseService {
         });
         return entities;
     }
+    /**
+     * Queries entity records with filters, sorting, and pagination
+     *
+     * @param id - UUID of the entity
+     * @param options - Query options including filterGroup, selectedFields, sortOptions, and pagination
+     * @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
+     *   or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
+     *
+     * @example
+     * ```typescript
+     * import { Entities, LogicalOperator, QueryFilterOperator } from '@uipath/uipath-typescript/entities';
+     *
+     * const entities = new Entities(sdk);
+     *
+     * // Non-paginated query with a filter
+     * const result = await entities.queryRecordsById("<entityId>", {
+     *   filterGroup: {
+     *     logicalOperator: LogicalOperator.And,
+     *     queryFilters: [
+     *       { fieldName: "status", operator: QueryFilterOperator.Equals, value: "active" }
+     *     ]
+     *   },
+     *   sortOptions: [{ fieldName: "created_at", isDescending: true }],
+     * });
+     * console.log(`Found ${result.totalCount} records`);
+     *
+     * // With pagination
+     * const page1 = await entities.queryRecordsById("<entityId>", {
+     *   filterGroup: { queryFilters: [{ fieldName: "status", operator: QueryFilterOperator.Equals, value: "active" }] },
+     *   pageSize: 25,
+     * });
+     * if (page1.hasNextPage) {
+     *   const page2 = await entities.queryRecordsById("<entityId>", { cursor: page1.nextCursor });
+     * }
+     * ```
+     */
+    async queryRecordsById(id, options) {
+        return PaginationHelpers.getAll({
+            serviceAccess: this.createPaginationServiceAccess(),
+            getEndpoint: () => DATA_FABRIC_ENDPOINTS.ENTITY.QUERY_BY_ID(id),
+            method: HTTP_METHODS.POST,
+            pagination: {
+                paginationType: PaginationType.OFFSET,
+                itemsField: ENTITY_PAGINATION.ITEMS_FIELD,
+                totalCountField: ENTITY_PAGINATION.TOTAL_COUNT_FIELD,
+                paginationParams: {
+                    pageSizeParam: ENTITY_OFFSET_PARAMS.PAGE_SIZE_PARAM,
+                    offsetParam: ENTITY_OFFSET_PARAMS.OFFSET_PARAM,
+                    countParam: ENTITY_OFFSET_PARAMS.COUNT_PARAM
+                }
+            },
+            excludeFromPrefix: ['expansionLevel', 'filterGroup', 'selectedFields', 'sortOptions']
+        }, options);
+    }
+    /**
+     * Imports records from a CSV file into an entity
+     *
+     * @param id - UUID of the entity
+     * @param file - CSV file to import (Blob, File, or Uint8Array)
+     * @returns Promise resolving to import result with record counts
+     *
+     * @example
+     * ```typescript
+     * import { Entities } from '@uipath/uipath-typescript/entities';
+     *
+     * const entities = new Entities(sdk);
+     *
+     * // Browser: upload from file input
+     * const fileInput = document.getElementById('csv-input') as HTMLInputElement;
+     * const result = await entities.importRecordsById("<entityId>", fileInput.files[0]);
+     *
+     * // Node.js: read from disk
+     * const fileBuffer = fs.readFileSync('records.csv');
+     * const result = await entities.importRecordsById("<entityId>", new Blob([fileBuffer], { type: 'text/csv' }));
+     *
+     * console.log(`Inserted ${result.insertedRecords} of ${result.totalRecords} records`);
+     * if (result.errorFileLink) {
+     *   console.log(`Error file link: ${result.errorFileLink}`);
+     * }
+     * ```
+     * @internal
+     */
+    async importRecordsById(id, file) {
+        const formData = new FormData();
+        if (file instanceof Uint8Array) {
+            formData.append('file', new Blob([file.buffer]));
+        }
+        else {
+            formData.append('file', file);
+        }
+        const response = await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.BULK_UPLOAD_BY_ID(id), formData);
+        return response.data;
+    }
     /**
      * Downloads an attachment from an entity record field
      *
@@ -8260,18 +8444,169 @@ class EntityService extends BaseService {
         return this.insertRecordsById(id, data, options);
     }
     /**
-     * @hidden
-     * @deprecated Use {@link updateRecordsById} instead.
+     * Creates a new Data Fabric entity with the given schema
+     *
+     * @param name - Entity name — must start with a letter and contain
+     *   only letters, numbers, and underscores (e.g., `"productCatalog"`).
+     * @param fields - Array of field definitions
+     * @param options - Optional entity-level settings ({@link EntityCreateOptions})
+     * @returns Promise resolving to the ID of the created entity
+     *
+     * @example
+     * ```typescript
+     * const entityId = await entities.create("product_catalog", [
+     *   { fieldName: "product_name", type: EntityFieldDataType.STRING, isRequired: true, isUnique: true },
+     *   { fieldName: "price", type: EntityFieldDataType.INTEGER, defaultValue: "0" },
+     * ], { displayName: "Product Catalog", description: "Our product catalog", isRbacEnabled: true });
+     * ```
+     * @internal
      */
-    async updateById(id, data, options = {}) {
-        return this.updateRecordsById(id, data, options);
+    async create(name, fields, options) {
+        this.validateName(name, 'entity');
+        for (const field of fields) {
+            this.validateName(field.fieldName, 'field');
+        }
+        const opts = options ?? {};
+        const payload = {
+            ...(opts.description !== undefined && { description: opts.description }),
+            displayName: opts.displayName ?? name,
+            entityDefinition: {
+                name,
+                fields: fields.map(f => this.buildSchemaFieldPayload(f)),
+                folderId: opts.folderKey ?? DATA_FABRIC_TENANT_FOLDER_ID,
+                isRbacEnabled: opts.isRbacEnabled ?? false,
+                isInsightsEnabled: opts.isAnalyticsEnabled ?? false,
+                externalFields: opts.externalFields ?? [],
+            },
+        };
+        const response = await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPSERT, payload);
+        return response.data;
     }
     /**
-     * @hidden
-     * @deprecated Use {@link deleteRecordsById} instead.
+     * Deletes a Data Fabric entity and all its records
+     *
+     * @param id - UUID of the entity to delete
+     * @returns Promise resolving when the entity is deleted
+     *
+     * @example
+     * ```typescript
+     * await entities.deleteById("<entityId>");
+     * ```
+     * @internal
      */
-    async deleteById(id, recordIds, options = {}) {
-        return this.deleteRecordsById(id, recordIds, options);
+    async deleteById(id) {
+        await this.delete(DATA_FABRIC_ENDPOINTS.ENTITY.DELETE(id));
+    }
+    /**
+     * Updates an existing Data Fabric entity — schema and/or metadata.
+     *
+     * Provide any combination of schema fields (`addFields`, `removeFields`, `updateFields`) and
+     * metadata fields (`displayName`, `description`, `isRbacEnabled`). Each group is applied
+     * only when the corresponding fields are present.
+     *
+     * **Warning:** Schema changes (`addFields`, `removeFields`, `updateFields`) use a
+     * read-modify-write pattern — concurrent calls on the same entity may silently
+     * overwrite each other's changes.
+     *
+     * @param id - UUID of the entity to update
+     * @param options - Changes to apply ({@link EntityUpdateByIdOptions})
+     * @returns Promise resolving when the update is complete
+     *
+     * @example
+     * ```typescript
+     * // Schema-only
+     * await entities.updateById("<entityId>", {
+     *   addFields: [{ fieldName: "notes", type: EntityFieldDataType.MULTILINE_TEXT }],
+     *   removeFields: [{ fieldName: "old_field" }],
+     * });
+     *
+     * // Metadata-only
+     * await entities.updateById("<entityId>", {
+     *   displayName: "My Updated Entity",
+     *   description: "Updated description",
+     * });
+     *
+     * // Combined
+     * await entities.updateById("<entityId>", {
+     *   updateFields: [{ id: "<fieldId>", displayName: "Unit Price", isRequired: true }],
+     *   displayName: "Price Catalog",
+     * });
+     * ```
+     * @internal
+     */
+    async updateById(id, options) {
+        const opts = options ?? {};
+        const hasSchemaChanges = !!(opts.addFields?.length || opts.removeFields?.length || opts.updateFields?.length);
+        const hasMetadataChanges = opts.displayName !== undefined || opts.description !== undefined || opts.isRbacEnabled !== undefined;
+        if (hasSchemaChanges) {
+            await this.applySchemaUpdate(id, opts);
+        }
+        if (hasMetadataChanges) {
+            await this.patch(DATA_FABRIC_ENDPOINTS.ENTITY.UPDATE_METADATA(id), {
+                ...(opts.displayName !== undefined && { displayName: opts.displayName }),
+                ...(opts.description !== undefined && { description: opts.description }),
+                ...(opts.isRbacEnabled !== undefined && { isRbacEnabled: opts.isRbacEnabled }),
+            });
+        }
+    }
+    /**
+     * Fetches the current entity schema, applies the field delta, then posts the full updated schema.
+     *
+     * @param entityId - UUID of the entity to update
+     * @param options - Field changes to apply
+     * @private
+     */
+    async applySchemaUpdate(entityId, options) {
+        const entityResponse = await this.get(DATA_FABRIC_ENDPOINTS.ENTITY.GET_BY_ID(entityId));
+        const raw = entityResponse.data;
+        // Carry forward existing non-system fields from GET response (skip system/primary-key fields)
+        let fields = (raw.fields ?? [])
+            .filter(f => !f.isSystemField && !f.isPrimaryKey);
+        // Filter out removed fields
+        if (options.removeFields?.length) {
+            const removeSet = new Set(options.removeFields.map(r => r.fieldName));
+            fields = fields.filter(f => !removeSet.has(f.name));
+        }
+        // Apply per-field metadata updates (matched by field ID)
+        if (options.updateFields?.length) {
+            const updateMap = new Map(options.updateFields.map(u => [u.id, u]));
+            fields = fields.map(f => {
+                const update = updateMap.get(f.id ?? '');
+                if (!update)
+                    return f;
+                return {
+                    ...f,
+                    ...(update.displayName !== undefined && { displayName: update.displayName }),
+                    ...(update.description !== undefined && { description: update.description }),
+                    ...(update.isRequired !== undefined && { isRequired: update.isRequired }),
+                    ...(update.isUnique !== undefined && { isUnique: update.isUnique }),
+                    ...(update.isRbacEnabled !== undefined && { isRbacEnabled: update.isRbacEnabled }),
+                    ...(update.isEncrypted !== undefined && { isEncrypted: update.isEncrypted }),
+                    ...(update.defaultValue !== undefined && { defaultValue: update.defaultValue }),
+                };
+            });
+        }
+        // Build and append new fields
+        const newFields = [];
+        if (options.addFields?.length) {
+            for (const field of options.addFields) {
+                this.validateName(field.fieldName, 'field');
+            }
+            newFields.push(...options.addFields.map(f => this.buildSchemaFieldPayload(f)));
+        }
+        await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPSERT, {
+            displayName: raw.displayName,
+            description: raw.description,
+            entityDefinition: {
+                id: entityId,
+                name: raw.name,
+                fields: [...fields, ...newFields],
+                folderId: raw.folderId ?? DATA_FABRIC_TENANT_FOLDER_ID,
+                isRbacEnabled: raw.isRbacEnabled ?? false,
+                isInsightsEnabled: raw.isInsightsEnabled ?? false,
+                externalFields: raw.externalFields ?? [],
+            },
+        });
     }
     /**
      * Orchestrates all field mapping transformations
@@ -8295,11 +8630,20 @@ class EntityService extends BaseService {
         metadata.fields = metadata.fields.map(field => {
             // Rename sqlType to fieldDataType
             let transformedField = transformData(field, EntityMap);
-            // Map SQL field type to friendly name
+            // Map field type: prefer fieldDisplayType for types that share SQL types (File, ChoiceSet, AutoNumber)
             if (transformedField.fieldDataType?.name) {
-                const sqlTypeName = transformedField.fieldDataType.name;
-                if (EntityFieldTypeMap[sqlTypeName]) {
-                    transformedField.fieldDataType.name = EntityFieldTypeMap[sqlTypeName];
+                const displayTypeMapped = transformedField.fieldDisplayType
+                    ? FieldDisplayTypeToDataType[transformedField.fieldDisplayType]
+                    : undefined;
+                if (displayTypeMapped) {
+                    transformedField.fieldDataType.name = displayTypeMapped;
+                }
+                else {
+                    const rawSqlTypeName = field.sqlType?.name;
+                    const mapped = rawSqlTypeName ? EntityFieldTypeMap[rawSqlTypeName] : undefined;
+                    if (mapped) {
+                        transformedField.fieldDataType.name = mapped;
+                    }
                 }
             }
             this.transformNestedReferences(transformedField);
@@ -8343,7 +8687,44 @@ class EntityService extends BaseService {
             return externalSource;
         });
     }
+    /** Converts a user-facing EntityCreateFieldOptions to the raw API field payload */
+    buildSchemaFieldPayload(field) {
+        this.validateName(field.fieldName, 'field');
+        const mapping = EntitySchemaFieldTypeMap[field.type ?? exports.EntityFieldDataType.STRING];
+        return {
+            name: field.fieldName,
+            displayName: field.displayName ?? field.fieldName,
+            sqlType: { name: mapping.sqlTypeName },
+            fieldDisplayType: mapping.fieldDisplayType,
+            description: field.description ?? '',
+            isRequired: field.isRequired ?? false,
+            isUnique: field.isUnique ?? false,
+            isRbacEnabled: field.isRbacEnabled ?? false,
+            isEncrypted: field.isEncrypted ?? false,
+            ...(field.defaultValue !== undefined && { defaultValue: field.defaultValue }),
+            ...(field.choiceSetId !== undefined && { choiceSetId: field.choiceSetId }),
+            ...(field.referenceEntityName !== undefined && { referenceEntityName: field.referenceEntityName }),
+            ...(field.referenceFieldName !== undefined && { referenceFieldName: field.referenceFieldName }),
+        };
+    }
+    validateName(name, context) {
+        if (name.length < 3 || name.length > 100 || !/^[a-zA-Z]\w*$/.test(name)) {
+            const suggestion = name.replace(/\W/g, '').replace(/^[0-9_]+/, '');
+            const defaultName = `My${context.charAt(0).toUpperCase() + context.slice(1)}`;
+            throw new ValidationError({
+                message: `Invalid ${context} name '${name}'. Must start with a letter, contain only letters, numbers, and underscores, 3–100 characters (e.g., "${suggestion || defaultName}").`
+            });
+        }
+        if (context === 'field' && EntityService.RESERVED_FIELD_NAMES.has(name)) {
+            throw new ValidationError({
+                message: `Field name '${name}' is reserved. Reserved names: ${[...EntityService.RESERVED_FIELD_NAMES].join(', ')}.`
+            });
+        }
+    }
 }
+EntityService.RESERVED_FIELD_NAMES = new Set([
+    'Id', 'CreatedBy', 'CreateTime', 'UpdatedBy', 'UpdateTime'
+]);
 __decorate([
     track('Entities.GetById')
 ], EntityService.prototype, "getById", null);
@@ -8371,6 +8752,12 @@ __decorate([
 __decorate([
     track('Entities.GetAll')
 ], EntityService.prototype, "getAll", null);
+__decorate([
+    track('Entities.QueryRecordsById')
+], EntityService.prototype, "queryRecordsById", null);
+__decorate([
+    track('Entities.ImportRecordsById')
+], EntityService.prototype, "importRecordsById", null);
 __decorate([
     track('Entities.DownloadAttachment')
 ], EntityService.prototype, "downloadAttachment", null);
@@ -8380,6 +8767,15 @@ __decorate([
 __decorate([
     track('Entities.DeleteAttachment')
 ], EntityService.prototype, "deleteAttachment", null);
+__decorate([
+    track('Entities.Create')
+], EntityService.prototype, "create", null);
+__decorate([
+    track('Entities.DeleteById')
+], EntityService.prototype, "deleteById", null);
+__decorate([
+    track('Entities.UpdateById')
+], EntityService.prototype, "updateById", null);
 
 class ChoiceSetService extends BaseService {
     /**
@@ -11110,6 +11506,50 @@ class JobService extends FolderScopedService {
             },
         }, options);
     }
+    /**
+     * Gets a job by its unique key (GUID).
+     *
+     * Returns the full job details including state, timing, input/output arguments, and error information.
+     * Use `expand` to include related entities like `robot`, or `machine`.
+     *
+     * @param id - The unique key (GUID) of the job to retrieve
+     * @param folderId - The folder ID where the job resides
+     * @param options - Optional query options for expanding or selecting fields
+     * @returns Promise resolving to a {@link JobGetResponse} with full job details and bound methods
+     *
+     * @example
+     * ```typescript
+     * // Get a job by key
+     * const job = await jobs.getById(<id>, <folderId>);
+     * console.log(job.state, job.processName);
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // With expanded related entities
+     * const job = await jobs.getById(<id>, <folderId>, {
+     *   expand: 'robot,machine'
+     * });
+     * console.log(job.robot?.name, job.machine?.name);
+     * ```
+     */
+    async getById(id, folderId, options) {
+        if (!id) {
+            throw new ValidationError({ message: 'id is required for getById' });
+        }
+        if (!folderId) {
+            throw new ValidationError({ message: 'folderId is required for getById' });
+        }
+        const headers = createHeaders({ [FOLDER_ID]: folderId });
+        const keysToPrefix = Object.keys(options ?? {});
+        const apiOptions = options ? addPrefixToKeys(options, ODATA_PREFIX, keysToPrefix) : {};
+        const response = await this.get(JOB_ENDPOINTS.GET_BY_KEY(id), {
+            params: apiOptions,
+            headers,
+        });
+        const rawJob = transformData(pascalToCamelCaseKeys(response.data), JobMap);
+        return createJobWithMethods(rawJob, this);
+    }
     /**
      * Gets the output of a completed job.
      *
@@ -11146,34 +11586,20 @@ class JobService extends FolderScopedService {
         if (!jobKey) {
             throw new ValidationError({ message: 'jobKey is required for getOutput' });
         }
-        const job = await this.fetchJobByKey(jobKey, folderId);
-        if (job.OutputArguments) {
+        const job = await this.getById(jobKey, folderId, { select: 'outputArguments,outputFile' });
+        if (job.outputArguments) {
             try {
-                return JSON.parse(job.OutputArguments);
+                return JSON.parse(job.outputArguments);
             }
             catch {
                 throw new ServerError({ message: 'Failed to parse job output arguments as JSON' });
             }
         }
-        if (job.OutputFile) {
-            return this.downloadOutputFile(job.OutputFile);
+        if (job.outputFile) {
+            return this.downloadOutputFile(job.outputFile);
         }
         return null;
     }
-    /**
-     * Fetches a job by its Key (GUID) using the GetByKey endpoint.
-     * Only selects fields needed for output extraction.
-     */
-    async fetchJobByKey(jobKey, folderId) {
-        const headers = createHeaders({ [FOLDER_ID]: folderId });
-        const response = await this.get(JOB_ENDPOINTS.GET_BY_KEY(jobKey), {
-            params: {
-                $select: 'OutputArguments,OutputFile',
-            },
-            headers,
-        });
-        return response.data;
-    }
     /**
      * Downloads the output file content via the Attachments API.
      * 1. Fetches blob access info from the attachment using AttachmentService
@@ -11212,6 +11638,9 @@ class JobService extends FolderScopedService {
 __decorate([
     track('Jobs.GetAll')
 ], JobService.prototype, "getAll", null);
+__decorate([
+    track('Jobs.GetById')
+], JobService.prototype, "getById", null);
 __decorate([
     track('Jobs.GetOutput')
 ], JobService.prototype, "getOutput", null);