@uipath/uipath-typescript 1.4.0 → 1.4.2

package/dist/entities/index.cjs

@@ -1278,12 +1278,18 @@ class PaginationHelpers {
      * @returns Promise resolving to a paginated result
      */
     static async getAllPaginated(params) {
-        const { serviceAccess, getEndpoint, folderId, headers: providedHeaders, paginationParams, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getEndpoint, folderId, headers: providedHeaders, paginationParams, additionalParams, queryParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
         const endpoint = getEndpoint(folderId);
         const headers = providedHeaders ?? (folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {});
+        // On POST, the caller's options go in the body; queryParams stays in the URL.
+        // On GET, everything is URL — queryParams merges with additionalParams.
+        const isPost = method === HTTP_METHODS.POST;
+        const requestSpec = isPost
+            ? { body: additionalParams, params: queryParams }
+            : { params: { ...additionalParams, ...queryParams } };
         const paginatedResponse = await serviceAccess.requestWithPagination(method, endpoint, paginationParams, {
             headers,
-            params: additionalParams,
+            ...requestSpec,
             pagination: {
                 paginationType: options.paginationType || PaginationType.OFFSET,
                 itemsField: options.itemsField || DEFAULT_ITEMS_FIELD,
@@ -1308,7 +1314,7 @@ class PaginationHelpers {
      * @returns Promise resolving to an object with data and totalCount
      */
     static async getAllNonPaginated(params) {
-        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, headers: providedHeaders, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, headers: providedHeaders, additionalParams, queryParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
         // Set default field names
         const itemsField = options.itemsField || DEFAULT_ITEMS_FIELD;
         const totalCountField = options.totalCountField || DEFAULT_TOTAL_COUNT_FIELD;
@@ -1318,11 +1324,11 @@ class PaginationHelpers {
         // Make the API call based on method
         let response;
         if (method === HTTP_METHODS.POST) {
-            response = await serviceAccess.post(endpoint, additionalParams, { headers });
+            response = await serviceAccess.post(endpoint, additionalParams, { headers, params: queryParams });
         }
         else {
             response = await serviceAccess.get(endpoint, {
-                params: additionalParams,
+                params: { ...additionalParams, ...queryParams },
                 headers
             });
         }
@@ -1377,6 +1383,7 @@ class PaginationHelpers {
                 headers: config.headers,
                 paginationParams: cursor ? { cursor, pageSize } : jumpToPage !== undefined ? { jumpToPage, pageSize } : { pageSize },
                 additionalParams: prefixedOptions,
+                queryParams: config.queryParams,
                 transformFn: config.transformFn,
                 method: config.method,
                 options: {
@@ -1394,6 +1401,7 @@ class PaginationHelpers {
             folderId,
             headers: config.headers,
             additionalParams: prefixedOptions,
+            queryParams: config.queryParams,
             transformFn: config.transformFn,
             method: config.method,
             options: {
@@ -1585,18 +1593,17 @@ class BaseService {
         const params = this.validateAndPreparePaginationParams(paginationType, paginationOptions);
         // Prepare request parameters based on pagination type
         const requestParams = this.preparePaginationRequestParams(paginationType, params, options.pagination);
-        // For POST requests, merge pagination params into body and set params to undefined; for GET, use query params
+        // Route pagination state to wherever the API expects it (body for POST, URL for GET).
+        // Caller-supplied options.body / options.params are respected as-is — the api-client
+        // already handles params (URL) and body (request body) independently for every method.
         if (method.toUpperCase() === 'POST') {
             const existingBody = (options.body && typeof options.body === 'object') ? options.body : {};
             options.body = {
                 ...existingBody,
-                ...options.params,
                 ...requestParams
             };
-            options.params = undefined;
         }
         else {
-            // Merge pagination parameters with existing parameters
             options.params = {
                 ...options.params,
                 ...requestParams
@@ -1962,6 +1969,9 @@ const DATA_FABRIC_TENANT_FOLDER_ID = '00000000-0000-0000-0000-000000000000';
 const DATA_FABRIC_ENDPOINTS = {
     ENTITY: {
         GET_ALL: `${DATAFABRIC_BASE}/api/Entity`,
+        // Lists tenant-level and folder-level entities together.
+        // Used by getAll when includeFolderEntities is true.
+        GET_ALL_V2: `${DATAFABRIC_BASE}/api/v2/Entity`,
         GET_ENTITY_RECORDS: (entityId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/read`,
         GET_BY_ID: (entityId) => `${DATAFABRIC_BASE}/api/Entity/${entityId}`,
         GET_RECORD_BY_ID: (entityId, recordId) => `${DATAFABRIC_BASE}/api/EntityService/entity/${entityId}/read/${recordId}`,
@@ -2060,6 +2070,14 @@ var SqlFieldType;
     SqlFieldType["MULTILINE"] = "MULTILINE";
 })(SqlFieldType || (SqlFieldType = {}));
 
+/**
+ * Numeric type IDs that pair with {@link EntityType} on reference payloads
+ * (entityType + entityTypeId travel together in `referenceEntity` /
+ * `referenceChoiceSet` bodies on cross-folder schema upserts).
+ */
+const ENTITY_TYPE_IDS = {
+    [exports.EntityType.ChoiceSet]: 1,
+};
 /**
  * Maps fields for Entities
  */
@@ -2222,7 +2240,7 @@ class EntityService extends BaseService {
      * Gets entity metadata by entity ID with attached operation methods
      *
      * @param id - UUID of the entity
-     * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities)
+     * @param options - Optional {@link EntityGetByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
      * @returns Promise resolving to entity metadata with schema information and operation methods
      *
      * @example
@@ -2262,7 +2280,7 @@ class EntityService extends BaseService {
      * Gets entity records by entity ID
      *
      * @param entityId - UUID of the entity
-     * @param options - Query options including expansionLevel and pagination options
+     * @param options - Query options including expansionLevel and pagination options The `folderKey` property is **experimental**.
      * @returns Promise resolving to an array of entity records or paginated response
      *
      * @example
@@ -2290,6 +2308,9 @@ class EntityService extends BaseService {
      *   cursor: paginatedResponse.nextCursor,
      *   expansionLevel: 1
      * });
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * const records = await entities.getAllRecords("<entityId>", { folderKey: "<folderKey>" });
      * ```
      */
     async getAllRecords(entityId, options) {
@@ -2319,7 +2340,7 @@ class EntityService extends BaseService {
      *
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record
-     * @param options - Query options including expansionLevel
+     * @param options - Query options including `expansionLevel` and `folderKey` The `folderKey` property is **experimental**.
      * @returns Promise resolving to the entity record
      *
      * @example
@@ -2331,6 +2352,11 @@ class EntityService extends BaseService {
      * const record = await sdk.entities.getRecordById(<entityId>, <recordId>, {
      *   expansionLevel: 1
      * });
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * const record = await sdk.entities.getRecordById(<entityId>, <recordId>, {
+     *   folderKey: "<folderKey>"
+     * });
      * ```
      */
     async getRecordById(entityId, recordId, options = {}) {
@@ -2345,7 +2371,7 @@ class EntityService extends BaseService {
      *
      * @param entityId - UUID of the entity
      * @param data - Record to insert
-     * @param options - Insert options
+     * @param options - Insert options The `folderKey` property is **experimental**.
      * @returns Promise resolving to the inserted record with generated record ID
      *
      * @example
@@ -2361,6 +2387,11 @@ class EntityService extends BaseService {
      * const result = await entities.insertRecordById("<entityId>", { name: "John", age: 30 }, {
      *   expansionLevel: 1
      * });
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.insertRecordById("<entityId>", { name: "John", age: 30 }, {
+     *   folderKey: "<folderKey>"
+     * });
      * ```
      */
     async insertRecordById(id, data, options = {}) {
@@ -2378,7 +2409,7 @@ class EntityService extends BaseService {
      *
      * @param entityId - UUID of the entity
      * @param data - Array of records to insert
-     * @param options - Insert options
+     * @param options - Insert options The `folderKey` property is **experimental**.
      * @returns Promise resolving to insert response
      *
      * @example
@@ -2401,6 +2432,12 @@ class EntityService extends BaseService {
      *   expansionLevel: 1,
      *   failOnFirst: true
      * });
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.insertRecordsById("<entityId>", [
+     *   { name: "John", age: 30 },
+     *   { name: "Jane", age: 25 }
+     * ], { folderKey: "<folderKey>" });
      * ```
      */
     async insertRecordsById(id, data, options = {}) {
@@ -2420,7 +2457,7 @@ class EntityService extends BaseService {
      * @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
+     * @param options - Update options The `folderKey` property is **experimental**.
      * @returns Promise resolving to the updated record
      *
      * @example
@@ -2436,6 +2473,11 @@ class EntityService extends BaseService {
      * const result = await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated", age: 31 }, {
      *   expansionLevel: 1
      * });
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.updateRecordById("<entityId>", "<recordId>", { name: "John Updated" }, {
+     *   folderKey: "<folderKey>"
+     * });
      * ```
      */
     async updateRecordById(entityId, recordId, data, options = {}) {
@@ -2454,7 +2496,7 @@ class EntityService extends BaseService {
      * @param entityId - UUID of the entity
      * @param data - Array of records to update. Each record MUST contain the record Id,
      *               otherwise the update will fail.
-     * @param options - Update options
+     * @param options - Update options The `folderKey` property is **experimental**.
      * @returns Promise resolving to update response
      *
      * @example
@@ -2477,6 +2519,11 @@ class EntityService extends BaseService {
      *   expansionLevel: 1,
      *   failOnFirst: true
      * });
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.updateRecordsById("<entityId>", [
+     *   { Id: "123", name: "John Updated" }
+     * ], { folderKey: "<folderKey>" });
      * ```
      */
     async updateRecordsById(id, data, options = {}) {
@@ -2497,7 +2544,7 @@ class EntityService extends BaseService {
      *
      * @param entityId - UUID of the entity
      * @param recordIds - Array of record UUIDs to delete
-     * @param options - Delete options
+     * @param options - Delete options The `folderKey` property is **experimental**.
      * @returns Promise resolving to delete response
      *
      * @example
@@ -2510,6 +2557,11 @@ class EntityService extends BaseService {
      * const result = await entities.deleteRecordsById("<entityId>", [
      *   "<recordId-1>", "<recordId-2>"
      * ]);
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.deleteRecordsById("<entityId>", [
+     *   "<recordId-1>", "<recordId-2>"
+     * ], { folderKey: "<folderKey>" });
      * ```
      */
     async deleteRecordsById(id, recordIds, options = {}) {
@@ -2530,7 +2582,7 @@ class EntityService extends BaseService {
      *
      * @param entityId - UUID of the entity
      * @param recordId - UUID of the record to delete
-     * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities)
+     * @param options - Optional {@link EntityDeleteRecordByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
      * @returns Promise resolving to void on success
      * @example
      * ```typescript
@@ -2548,8 +2600,14 @@ class EntityService extends BaseService {
         await this.delete(DATA_FABRIC_ENDPOINTS.ENTITY.DELETE_RECORD_BY_ID(entityId, recordId), { headers: createHeaders({ [FOLDER_KEY]: options?.folderKey }) });
     }
     /**
-     * Gets all entities in the system
+     * Gets entities in the tenant.
+     *
+     * Three call modes:
+     * - `getAll()` — default. Returns only tenant-level entities.
+     * - `getAll({ folderKey: "<uuid>" })` — preferred for folder-scoped data. Returns only entities in that folder.
+     * - `getAll({ includeFolderEntities: true })` — returns tenant-level **and** folder-level entities together. `folderKey` is preferred over `includeFolderEntities` when both are set.
      *
+     * @param options - Optional {@link EntityGetAllOptions} (`folderKey` to list a single folder's entities — preferred when scoping to a folder; `includeFolderEntities: true` to list tenant + folder entities together) The `folderKey` property is **experimental**.
      * @returns Promise resolving to an array of entity metadata
      *
      * @example
@@ -2558,15 +2616,29 @@ class EntityService extends BaseService {
      *
      * const entities = new Entities(sdk);
      *
-     * // Get all entities
-     * const allEntities = await entities.getAll();
+     * // Tenant-only (default)
+     * const tenantEntities = await entities.getAll();
+     *
+     * // A single folder's entities (preferred when targeting a specific folder)
+     * const folderEntities = await entities.getAll({ folderKey: "<folderKey>" });
+     *
+     * // Tenant + folder entities together
+     * const allEntities = await entities.getAll({ includeFolderEntities: true });
      *
      * // Call operations on an entity
-     * const records = await allEntities[0].getAllRecords();
+     * const records = await tenantEntities[0].getAllRecords();
      * ```
      */
-    async getAll() {
-        const response = await this.get(DATA_FABRIC_ENDPOINTS.ENTITY.GET_ALL);
+    async getAll(options) {
+        // folderKey is preferred over includeFolderEntities: when present, scope to that folder
+        // via the v1 endpoint + header. Only when no folderKey is given AND includeFolderEntities
+        // is explicitly true does the SDK switch to the v2 endpoint (returns tenant + folder
+        // entities together). Default (no options or includeFolderEntities omitted) stays on
+        // the v1 endpoint = tenant only.
+        const endpoint = !options?.folderKey && options?.includeFolderEntities
+            ? DATA_FABRIC_ENDPOINTS.ENTITY.GET_ALL_V2
+            : DATA_FABRIC_ENDPOINTS.ENTITY.GET_ALL;
+        const response = await this.get(endpoint, { headers: createHeaders({ [FOLDER_KEY]: options?.folderKey }) });
         // Apply transformations
         const entities = response.data.map(entity => {
             // Transform each entity
@@ -2581,7 +2653,7 @@ class EntityService extends BaseService {
      * Queries entity records with filters, sorting, aggregates, and pagination
      *
      * @param id - UUID of the entity
-     * @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination
+     * @param options - Query options including filterGroup, selectedFields, sortOptions, aggregates, groupBy, and pagination The `folderKey` property is **experimental**.
      * @returns Promise resolving to {@link NonPaginatedResponse} without pagination options,
      *   or {@link PaginatedResponse} when `pageSize`, `cursor`, or `jumpToPage` are provided
      *
@@ -2628,18 +2700,24 @@ class EntityService extends BaseService {
      *     { function: EntityAggregateFunction.Avg, field: "amount", alias: "avgAmount" },
      *   ],
      * });
+     *
+     * // Folder-scoped entity: pass the entity's folder key
+     * await entities.queryRecordsById("<entityId>", {
+     *   filterGroup: { queryFilters: [{ fieldName: "status", operator: QueryFilterOperator.Equals, value: "active" }] },
+     *   folderKey: "<folderKey>",
+     * });
      * ```
      */
     async queryRecordsById(id, options) {
-        // folderKey is header-only — destructure it out so PaginationHelpers doesn't include
-        // it in the POST body alongside the query filters.
-        const { folderKey, ...rest } = options ?? {};
+        // folderKey is header-only; expansionLevel must be sent as a query param by PaginationHelpers.
+        const { folderKey, expansionLevel, ...rest } = options ?? {};
         const downstreamOptions = options === undefined ? undefined : rest;
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => DATA_FABRIC_ENDPOINTS.ENTITY.QUERY_BY_ID(id),
             method: HTTP_METHODS.POST,
             headers: createHeaders({ [FOLDER_KEY]: folderKey }),
+            queryParams: createParams({ expansionLevel }),
             pagination: {
                 paginationType: PaginationType.OFFSET,
                 itemsField: ENTITY_PAGINATION.ITEMS_FIELD,
@@ -2650,7 +2728,7 @@ class EntityService extends BaseService {
                     countParam: ENTITY_OFFSET_PARAMS.COUNT_PARAM
                 }
             },
-            excludeFromPrefix: ['expansionLevel', 'filterGroup', 'selectedFields', 'sortOptions', 'aggregates', 'groupBy']
+            excludeFromPrefix: ['filterGroup', 'selectedFields', 'sortOptions', 'aggregates', 'groupBy']
         }, downstreamOptions);
     }
     /**
@@ -2658,7 +2736,7 @@ class EntityService extends BaseService {
      *
      * @param id - UUID of the entity
      * @param file - CSV file to import (Blob, File, or Uint8Array)
-     * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities)
+     * @param options - Optional {@link EntityImportRecordsByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
      * @returns Promise resolving to import result with record counts
      *
      * @example
@@ -2701,7 +2779,7 @@ class EntityService extends BaseService {
      * @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
-     * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
+     * @param options - Optional {@link EntityDownloadAttachmentOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
      * @returns Promise resolving to Blob containing the file content
      *
      * @example
@@ -2739,7 +2817,7 @@ class EntityService extends BaseService {
      * @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`, `folderKey` for folder-scoped entities)
+     * @param options - Optional {@link EntityUploadAttachmentOptions} (e.g. `expansionLevel`, `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
      * @returns Promise resolving to {@link EntityUploadAttachmentResponse}
      *
      * @example
@@ -2784,7 +2862,7 @@ class EntityService extends BaseService {
      * @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
-     * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities)
+     * @param options - Optional {@link EntityDeleteAttachmentOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
      * @returns Promise resolving to {@link EntityDeleteAttachmentResponse}
      *
      * @example
@@ -2839,7 +2917,7 @@ class EntityService extends BaseService {
      * @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})
+     * @param options - Optional entity-level settings ({@link EntityCreateOptions}) The `folderKey` property is **experimental**.
      * @returns Promise resolving to the ID of the created entity
      *
      * @example
@@ -2855,17 +2933,36 @@ class EntityService extends BaseService {
      *   { fieldName: "price", type: EntityFieldDataType.DECIMAL, decimalPrecision: 4, maxValue: 999999, minValue: 0 },
      *   { fieldName: "quantity", type: EntityFieldDataType.INTEGER, maxValue: 10000, minValue: 1, defaultValue: "0" },
      * ]);
+     *
+     * // Cross-folder references — link a folder-scoped entity to entities and
+     * // system choice sets that live in another folder or at the tenant level.
+     * await entities.create("orderLine", [
+     *   {
+     *     fieldName: "order",
+     *     type: EntityFieldDataType.RELATIONSHIP,
+     *     referenceEntityId: "<orderEntityId>",
+     *     referenceFieldId: "<orderEntityPkId>",
+     *     referenceFolderKey: "<otherFolderKey>",     // target lives in a different folder
+     *   },
+     *   {
+     *     fieldName: "userType",
+     *     type: EntityFieldDataType.CHOICE_SET_SINGLE,
+     *     choiceSetId: "<systemUserTypeChoiceSetId>", // tenant-level system choice set
+     *     // referenceFolderKey omitted → SDK looks up the target at tenant scope
+     *   },
+     * ], { folderKey: "<sourceFolderKey>" });
      * ```
      * @internal
      */
     async create(name, fields, options) {
         const opts = options ?? {};
+        const fieldPayloads = await this.buildFieldsWithReferenceMeta(fields);
         const payload = {
             ...(opts.description !== undefined && { description: opts.description }),
             displayName: opts.displayName ?? name,
             entityDefinition: {
                 name,
-                fields: fields.map(f => this.buildSchemaFieldPayload(f)),
+                fields: fieldPayloads,
                 folderId: opts.folderKey ?? DATA_FABRIC_TENANT_FOLDER_ID,
                 isRbacEnabled: opts.isRbacEnabled ?? false,
                 isInsightsEnabled: opts.isAnalyticsEnabled ?? false,
@@ -2879,7 +2976,7 @@ class EntityService extends BaseService {
      * Deletes a Data Fabric entity and all its records
      *
      * @param id - UUID of the entity to delete
-     * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities)
+     * @param options - Optional {@link EntityDeleteByIdOptions} (e.g. `folderKey` for folder-scoped entities) The `folderKey` property is **experimental**.
      * @returns Promise resolving when the entity is deleted
      *
      * @example
@@ -2906,7 +3003,7 @@ class EntityService extends BaseService {
      * overwrite each other's changes.
      *
      * @param id - UUID of the entity to update
-     * @param options - Changes to apply ({@link EntityUpdateByIdOptions})
+     * @param options - Changes to apply ({@link EntityUpdateByIdOptions}) The `folderKey` property is **experimental**.
      * @returns Promise resolving when the update is complete
      *
      * @example
@@ -3018,10 +3115,9 @@ class EntityService extends BaseService {
                 };
             });
         }
-        // Build and append new fields
         const newFields = [];
         if (options.addFields?.length) {
-            newFields.push(...options.addFields.map(f => this.buildSchemaFieldPayload(f)));
+            newFields.push(...await this.buildFieldsWithReferenceMeta(options.addFields));
         }
         await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPSERT, {
             displayName: raw.displayName,
@@ -3119,8 +3215,39 @@ class EntityService extends BaseService {
             return externalSource;
         });
     }
+    async buildFieldsWithReferenceMeta(fields) {
+        const metas = await Promise.all(fields.map(f => this.buildReferenceMeta(f)));
+        return fields.map((f, i) => this.buildSchemaFieldPayload(f, metas[i]));
+    }
+    // Choice-set targets resolve server-side by NAME (the API rejects cross-folder
+    // refs with empty target name even when folderId is supplied), so the SDK
+    // fetches the name once for each cross-folder choice-set field. Relationship
+    // targets resolve by folderId — no lookup needed.
+    async buildReferenceMeta(field) {
+        if (field.referenceFolderKey === undefined)
+            return undefined;
+        if (field.referenceEntityId === undefined && field.choiceSetId === undefined)
+            return undefined;
+        const folderId = field.referenceFolderKey;
+        const meta = {};
+        if (field.referenceEntityId !== undefined) {
+            meta.referenceEntity = { id: field.referenceEntityId, folderId };
+        }
+        if (field.choiceSetId !== undefined) {
+            const lookupFolderKey = folderId === DATA_FABRIC_TENANT_FOLDER_ID ? undefined : folderId;
+            const target = await this.get(DATA_FABRIC_ENDPOINTS.ENTITY.GET_BY_ID(field.choiceSetId), { headers: createHeaders({ [FOLDER_KEY]: lookupFolderKey }) });
+            meta.referenceChoiceSet = {
+                id: field.choiceSetId,
+                name: target.data.name,
+                folderId,
+                entityType: exports.EntityType.ChoiceSet,
+                entityTypeId: ENTITY_TYPE_IDS[exports.EntityType.ChoiceSet],
+            };
+        }
+        return meta;
+    }
     /** Converts a user-facing EntityCreateFieldOptions to the raw API field payload */
-    buildSchemaFieldPayload(field) {
+    buildSchemaFieldPayload(field, refMeta) {
         const fieldType = field.type ?? exports.EntityFieldDataType.STRING;
         this.validateFieldConstraints(fieldType, field, field.fieldName);
         const isRelationship = fieldType === exports.EntityFieldDataType.RELATIONSHIP;
@@ -3131,6 +3258,10 @@ class EntityService extends BaseService {
             });
         }
         const mapping = EntitySchemaFieldTypeMap[fieldType];
+        // Prefer the resolved {id, name, folderId} body so cross-folder targets resolve
+        // server-side; fall back to a bare {id} when no meta was fetched.
+        const referenceEntityBody = refMeta?.referenceEntity ?? (field.referenceEntityId === undefined ? undefined : { id: field.referenceEntityId });
+        const referenceChoiceSetBody = refMeta?.referenceChoiceSet;
         return {
             name: field.fieldName,
             displayName: field.displayName ?? field.fieldName,
@@ -3149,7 +3280,8 @@ class EntityService extends BaseService {
             ...(field.choiceSetId !== undefined && { choiceSetId: field.choiceSetId }),
             ...((isRelationship || isFile) && { isForeignKey: true }),
             ...(isRelationship && { referenceType: exports.ReferenceType.ManyToOne }),
-            ...(field.referenceEntityId !== undefined && { referenceEntity: { id: field.referenceEntityId } }),
+            ...(referenceEntityBody !== undefined && { referenceEntity: referenceEntityBody }),
+            ...(referenceChoiceSetBody !== undefined && { referenceChoiceSet: referenceChoiceSetBody }),
             ...(field.referenceFieldId !== undefined && { referenceField: { id: field.referenceFieldId } }),
         };
     }
@@ -3312,8 +3444,14 @@ __decorate([
 
 class ChoiceSetService extends BaseService {
     /**
-     * Gets all choice sets in the system
+     * Gets choice sets in the tenant.
+     *
+     * Three call modes:
+     * - `getAll()` — default. Returns only tenant-level choice sets.
+     * - `getAll({ folderKey: "<uuid>" })` — preferred for folder-scoped data. Returns only choice sets in that folder.
+     * - `getAll({ includeFolderChoiceSets: true })` — returns tenant-level **and** folder-level choice sets together. `folderKey` is preferred over `includeFolderChoiceSets` when both are set.
      *
+     * @param options - Optional {@link ChoiceSetGetAllOptions} (`folderKey` to list a single folder's choice sets — preferred when scoping to a folder; `includeFolderChoiceSets: true` to list tenant + folder choice sets together) The `folderKey` property is **experimental**.
      * @returns Promise resolving to an array of choice set metadata
      *
      * @example
@@ -3322,18 +3460,33 @@ class ChoiceSetService extends BaseService {
      *
      * const choiceSets = new ChoiceSets(sdk);
      *
-     * // Get all choice sets
-     * const allChoiceSets = await choiceSets.getAll();
+     * // Tenant-only (default)
+     * const tenantChoiceSets = await choiceSets.getAll();
      *
-     * // Iterate through choice sets
-     * allChoiceSets.forEach(choiceSet => {
-     *   console.log(`ChoiceSet: ${choiceSet.displayName} (${choiceSet.name})`);
-     *   console.log(`Description: ${choiceSet.description}`);
-     * });
+     * // A single folder's choice sets (preferred when targeting a specific folder)
+     * const folderChoiceSets = await choiceSets.getAll({ folderKey: "<folderKey>" });
+     *
+     * // Tenant + folder choice sets together
+     * const allChoiceSets = await choiceSets.getAll({ includeFolderChoiceSets: true });
      * ```
      */
-    async getAll() {
-        const rawResponse = await this.get(DATA_FABRIC_ENDPOINTS.CHOICESETS.GET_ALL);
+    async getAll(options) {
+        return this.fetchAllChoiceSets(options);
+    }
+    /**
+     * Internal helper that performs the choice-set fetch. Kept separate from the
+     * public `getAll()` so that internal callers (e.g. `resolveChoiceSetName`)
+     * can reuse it without triggering double `@track` telemetry.
+     */
+    async fetchAllChoiceSets(options) {
+        // The choice-set endpoint returns cross-scope results when called without
+        // a folder header. To stay tenant-only by default, send the tenant-marker
+        // UUID as the folder key unless the caller explicitly opts into cross-scope
+        // via includeFolderChoiceSets: true. folderKey is preferred over
+        // includeFolderChoiceSets when both are set.
+        const folderKey = options?.folderKey
+            ?? (options?.includeFolderChoiceSets ? undefined : DATA_FABRIC_TENANT_FOLDER_ID);
+        const rawResponse = await this.get(DATA_FABRIC_ENDPOINTS.CHOICESETS.GET_ALL, { headers: createHeaders({ [FOLDER_KEY]: folderKey }) });
         // Transform field names
         const data = rawResponse.data || [];
         return data.map(choiceSet => transformData(choiceSet, EntityMap));
@@ -3346,7 +3499,7 @@ class ChoiceSetService extends BaseService {
      * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
      *
      * @param choiceSetId - UUID of the choice set
-     * @param options - Pagination options
+     * @param options - Pagination options and optional `folderKey` for folder-scoped choice sets The `folderKey` property is **experimental**.
      * @returns Promise resolving to choice set values or paginated result
      *
      * @example
@@ -3375,6 +3528,9 @@ class ChoiceSetService extends BaseService {
      * if (page1.hasNextPage) {
      *   const page2 = await choiceSets.getById(choiceSetId, { cursor: page1.nextCursor });
      * }
+     *
+     * // Folder-scoped choice set
+     * const folderValues = await choiceSets.getById(choiceSetId, { folderKey: "<folderKey>" });
      * ```
      */
     async getById(choiceSetId, options) {
@@ -3383,11 +3539,16 @@ class ChoiceSetService extends BaseService {
             const camelCased = pascalToCamelCaseKeys(item);
             return transformData(camelCased, EntityMap);
         };
+        // folderKey is header-only — destructure it out so PaginationHelpers doesn't
+        // include it in the POST body alongside pagination params.
+        const { folderKey, ...rest } = options ?? {};
+        const downstreamOptions = options === undefined ? undefined : rest;
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => DATA_FABRIC_ENDPOINTS.CHOICESETS.GET_BY_ID(choiceSetId),
             transformFn,
             method: HTTP_METHODS.POST,
+            headers: createHeaders({ [FOLDER_KEY]: folderKey }),
             pagination: {
                 paginationType: PaginationType.OFFSET,
                 itemsField: CHOICESET_VALUES_PAGINATION.ITEMS_FIELD,
@@ -3398,7 +3559,7 @@ class ChoiceSetService extends BaseService {
                     countParam: ENTITY_OFFSET_PARAMS.COUNT_PARAM
                 }
             }
-        }, options);
+        }, downstreamOptions);
     }
     /**
      * Creates a new Data Fabric choice set
@@ -3406,7 +3567,7 @@ class ChoiceSetService extends BaseService {
      * @param name - Choice set name. Must start with a
      *   letter, may contain only letters, numbers, and underscores, length
      *   3–100 characters (e.g., `"expenseTypes"`).
-     * @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions})
+     * @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions}) The `folderKey` property is **experimental**.
      * @returns Promise resolving to the UUID of the created choice set
      *
      * @example
@@ -3437,7 +3598,7 @@ class ChoiceSetService extends BaseService {
                 folderId: opts.folderKey ?? DATA_FABRIC_TENANT_FOLDER_ID,
             },
         };
-        const response = await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.CREATE, payload);
+        const response = await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.CREATE, payload, { headers: createHeaders({ [FOLDER_KEY]: opts.folderKey }) });
         return response.data;
     }
     /**
@@ -3447,7 +3608,7 @@ class ChoiceSetService extends BaseService {
      * the call throws `ValidationError` if both are omitted.
      *
      * @param choiceSetId - UUID of the choice set to update
-     * @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions})
+     * @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions}) The `folderKey` property is **experimental**.
      * @returns Promise resolving when the update is complete
      *
      * @example
@@ -3472,12 +3633,13 @@ class ChoiceSetService extends BaseService {
         await this.patch(DATA_FABRIC_ENDPOINTS.CHOICESETS.UPDATE(choiceSetId), {
             ...(options.displayName !== undefined && { displayName: options.displayName }),
             ...(options.description !== undefined && { description: options.description }),
-        });
+        }, { headers: createHeaders({ [FOLDER_KEY]: options.folderKey }) });
     }
     /**
      * Deletes a Data Fabric choice set and all its values.
      *
      * @param choiceSetId - UUID of the choice set to delete
+     * @param options - Optional {@link ChoiceSetDeleteByIdOptions} (e.g. `folderKey` for folder-scoped choice sets) The `folderKey` property is **experimental**.
      * @returns Promise resolving when the choice set is deleted
      *
      * @example
@@ -3487,18 +3649,21 @@ class ChoiceSetService extends BaseService {
      * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
      *
      * await choicesets.deleteById(expenseTypes.id);
+     *
+     * // Folder-scoped choice set
+     * await choicesets.deleteById(expenseTypes.id, { folderKey: "<folderKey>" });
      * ```
      * @internal
      */
-    async deleteById(choiceSetId) {
-        await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.DELETE(choiceSetId), {});
+    async deleteById(choiceSetId, options) {
+        await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.DELETE(choiceSetId), {}, { headers: createHeaders({ [FOLDER_KEY]: options?.folderKey }) });
     }
     /**
      * Inserts a single value into a choice set.
      *
      * @param choiceSetId - UUID of the parent choice set
      * @param name - Identifier name of the new value (e.g., `"TRAVEL"`)
-     * @param options - Optional fields ({@link ChoiceSetValueInsertOptions})
+     * @param options - Optional fields ({@link ChoiceSetValueInsertOptions}) The `folderKey` property is **experimental**.
      * @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
      *
      * @example
@@ -3511,16 +3676,22 @@ class ChoiceSetService extends BaseService {
      *   displayName: 'Travel',
      * });
      * console.log(inserted.id);
+     *
+     * // Folder-scoped choice set: folderKey is required on the wire
+     * await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
+     *   displayName: 'Travel',
+     *   folderKey: "<folderKey>",
+     * });
      * ```
      * @internal
      */
     async insertValueById(choiceSetId, name, options) {
-        const choiceSetName = await this.resolveChoiceSetName(choiceSetId);
+        const choiceSetName = await this.resolveChoiceSetName(choiceSetId, options?.folderKey);
         const payload = {
             Name: name,
             ...(options?.displayName !== undefined && { DisplayName: options.displayName }),
         };
-        const response = await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.INSERT_BY_NAME(choiceSetName), payload);
+        const response = await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.INSERT_BY_NAME(choiceSetName), payload, { headers: createHeaders({ [FOLDER_KEY]: options?.folderKey }) });
         const camelCased = pascalToCamelCaseKeys(response.data);
         return transformData(camelCased, EntityMap);
     }
@@ -3533,6 +3704,7 @@ class ChoiceSetService extends BaseService {
      * @param choiceSetId - UUID of the parent choice set
      * @param valueId - UUID of the value to update
      * @param displayName - New human-readable display name for the value
+     * @param options - Optional {@link ChoiceSetValueUpdateOptions} — pass `folderKey` for folder-scoped choice sets; omit for tenant-level. The `folderKey` property is **experimental**.
      * @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
      *
      * @example
@@ -3544,13 +3716,18 @@ class ChoiceSetService extends BaseService {
      * const travel = values.items.find(v => v.name === 'TRAVEL');
      *
      * await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
+     *
+     * // Folder-scoped choice set: folderKey is required on the wire
+     * await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel', {
+     *   folderKey: "<folderKey>",
+     * });
      * ```
      * @internal
      */
-    async updateValueById(choiceSetId, valueId, displayName) {
-        const choiceSetName = await this.resolveChoiceSetName(choiceSetId);
+    async updateValueById(choiceSetId, valueId, displayName, options) {
+        const choiceSetName = await this.resolveChoiceSetName(choiceSetId, options?.folderKey);
         const payload = { DisplayName: displayName };
-        const response = await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.UPDATE_BY_NAME(choiceSetName, valueId), payload);
+        const response = await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.UPDATE_BY_NAME(choiceSetName, valueId), payload, { headers: createHeaders({ [FOLDER_KEY]: options?.folderKey }) });
         const camelCased = pascalToCamelCaseKeys(response.data);
         return transformData(camelCased, EntityMap);
     }
@@ -3559,6 +3736,7 @@ class ChoiceSetService extends BaseService {
      *
      * @param choiceSetId - UUID of the parent choice set
      * @param valueIds - Array of value UUIDs to delete
+     * @param options - Optional {@link ChoiceSetValueDeleteOptions} (e.g. `folderKey` for folder-scoped choice sets) The `folderKey` property is **experimental**.
      * @returns Promise resolving when the values are deleted
      *
      * @example
@@ -3568,14 +3746,20 @@ class ChoiceSetService extends BaseService {
      * const idsToDelete = values.items.slice(0, 2).map(v => v.id);
      *
      * await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
+     *
+     * // Folder-scoped choice set
+     * await choicesets.deleteValuesById('<choiceSetId>', idsToDelete, { folderKey: "<folderKey>" });
      * ```
      * @internal
      */
-    async deleteValuesById(choiceSetId, valueIds) {
-        await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.DELETE_BY_ID(choiceSetId), valueIds);
+    async deleteValuesById(choiceSetId, valueIds, options) {
+        await this.post(DATA_FABRIC_ENDPOINTS.CHOICESETS.DELETE_BY_ID(choiceSetId), valueIds, { headers: createHeaders({ [FOLDER_KEY]: options?.folderKey }) });
     }
-    async resolveChoiceSetName(choiceSetId) {
-        const all = await this.getAll();
+    async resolveChoiceSetName(choiceSetId, folderKey) {
+        // Use the un-tracked helper directly so we don't fire a duplicate
+        // `Choicesets.GetAll` telemetry event for every insertValueById /
+        // updateValueById call.
+        const all = await this.fetchAllChoiceSets(folderKey === undefined ? undefined : { folderKey });
         const match = all.find(cs => cs.id === choiceSetId);
         if (!match) {
             throw new NotFoundError({ message: `Choice set with id '${choiceSetId}' not found.` });