@uipath/uipath-typescript 1.3.9 → 1.3.11

package/dist/entities/index.d.ts

@@ -549,6 +549,8 @@ interface EntityFieldBase {
     isRbacEnabled?: boolean;
     /** Whether the field value is encrypted at rest (default: false) */
     isEncrypted?: boolean;
+    /** Whether the field is hidden from the UI (default: false) */
+    isHiddenField?: boolean;
     /** Default value for the field */
     defaultValue?: string;
     /** Maximum character length for STRING fields (default: 200, range: 1–4000) and MULTILINE_TEXT fields (default: 200, range: 1–10000). */
@@ -573,10 +575,10 @@ interface EntityCreateFieldOptions extends EntityFieldBase {
     type?: EntityFieldDataType;
     /** Choice set ID for choice-set fields */
     choiceSetId?: string;
-    /** Name of the referenced entity for relationship fields */
-    referenceEntityName?: string;
-    /** Name of the field in the referenced entity */
-    referenceFieldName?: string;
+    /** UUID of the referenced entity (required when `type` is `RELATIONSHIP` or `FILE`) */
+    referenceEntityId?: string;
+    /** UUID of the referenced field on the target entity (required when `type` is `RELATIONSHIP` or `FILE`) */
+    referenceFieldId?: string;
 }
 /**
  * Options for creating a new Data Fabric entity
@@ -806,10 +808,6 @@ interface FieldMetaData {
     referenceType?: ReferenceType;
     choiceSetId?: string;
     defaultValue?: string;
-    /** Name of the referenced entity (used on write payloads for relationship fields) */
-    referenceEntityName?: string;
-    /** Name of the field in the referenced entity (used on write payloads for relationship fields) */
-    referenceFieldName?: string;
 }
 /**
  * External object details
@@ -2296,8 +2294,6 @@ declare class EntityService extends BaseService implements EntityServiceModel {
      * override the defaults where the type accepts overrides.
      */
     private buildSqlTypeConstraints;
-    private static readonly RESERVED_FIELD_NAMES;
-    private validateName;
 }
 
 /**
@@ -2305,6 +2301,8 @@ declare class EntityService extends BaseService implements EntityServiceModel {
  * Only exposes essential fields to SDK users
  */
 interface ChoiceSetGetAllResponse {
+    /** UUID of the choice set */
+    id: string;
     /** Name identifier of the choice set */
     name: string;
     /** Human-readable display name of the choice set*/
@@ -2349,6 +2347,46 @@ interface ChoiceSetGetResponse {
  * Options for getting choice set values by choice set ID
  */
 type ChoiceSetGetByIdOptions = PaginationOptions;
+/**
+ * Options for creating a new choice set
+ */
+interface ChoiceSetCreateOptions {
+    /** Human-readable display name */
+    displayName?: string;
+    /** Optional choice set description */
+    description?: string;
+    /** UUID of the folder to place the choice set in (defaults to the tenant-level folder) */
+    folderKey?: string;
+}
+/**
+ * Options for updating an existing choice set's metadata
+ */
+interface ChoiceSetUpdateOptions {
+    /** New display name for the choice set */
+    displayName?: string;
+    /** New description for the choice set */
+    description?: string;
+}
+/**
+ * Optional fields when inserting a single value into a choice set.
+ *
+ * The required `name` identifier is passed as a positional argument to
+ * `insertValueById`.
+ */
+interface ChoiceSetValueInsertOptions {
+    /** Human-readable display name */
+    displayName?: string;
+}
+/**
+ * Response returned after inserting a choice-set value — the full value object.
+ */
+interface ChoiceSetValueInsertResponse extends ChoiceSetGetResponse {
+}
+/**
+ * Response returned after updating a choice-set value — the full value object.
+ */
+interface ChoiceSetValueUpdateResponse extends ChoiceSetGetResponse {
+}
 
 /**
  * Service for managing UiPath Data Fabric Choice Sets
@@ -2431,6 +2469,134 @@ interface ChoiceSetServiceModel {
      * ```
      */
     getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
+    /**
+     * Creates a new Data Fabric choice set
+     *
+     * @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})
+     * @returns Promise resolving to the UUID of the created choice set
+     *
+     * @example
+     * ```typescript
+     * // Minimal create
+     * const expenseTypesId = await choicesets.create("expense_types");
+     *
+     * // With display name and description
+     * const priorityLevelsId = await choicesets.create("priority_levels", {
+     *   displayName: "Priority Levels",
+     *   description: "Ticket priority categories",
+     * });
+     * ```
+     * @internal
+     */
+    create(name: string, options?: ChoiceSetCreateOptions): Promise<string>;
+    /**
+     * Updates an existing choice set's metadata (display name and/or description).
+     *
+     * **At least one of `displayName` or `description` must be provided** —
+     * 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})
+     * @returns Promise resolving when the update is complete
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.updateById(expenseTypes.id, {
+     *   displayName: "Expense Categories",
+     *   description: "Updated description",
+     * });
+     * ```
+     * @internal
+     */
+    updateById(choiceSetId: string, options: ChoiceSetUpdateOptions): Promise<void>;
+    /**
+     * Deletes a Data Fabric choice set and all its values.
+     *
+     * @param choiceSetId - UUID of the choice set to delete
+     * @returns Promise resolving when the choice set is deleted
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.deleteById(expenseTypes.id);
+     * ```
+     * @internal
+     */
+    deleteById(choiceSetId: string): Promise<void>;
+    /**
+     * 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})
+     * @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * const inserted = await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
+     *   displayName: 'Travel',
+     * });
+     * console.log(inserted.id);
+     * ```
+     * @internal
+     */
+    insertValueById(choiceSetId: string, name: string, options?: ChoiceSetValueInsertOptions): Promise<ChoiceSetValueInsertResponse>;
+    /**
+     * Updates an existing choice-set value's display name.
+     *
+     * Only `displayName` is mutable; the value's `name` (identifier) is fixed at
+     * insert time and cannot be changed.
+     *
+     * @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
+     * @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
+     *
+     * @example
+     * ```typescript
+     * // Get the choice set ID from getAll() and the value ID from getById()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     * const values = await choicesets.getById(expenseTypes.id);
+     * const travel = values.items.find(v => v.name === 'TRAVEL');
+     *
+     * await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
+     * ```
+     * @internal
+     */
+    updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
+    /**
+     * Deletes one or more values from a choice set.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param valueIds - Array of value UUIDs to delete
+     * @returns Promise resolving when the values are deleted
+     *
+     * @example
+     * ```typescript
+     * // Get the value IDs from getById()
+     * const values = await choicesets.getById('<choiceSetId>');
+     * const idsToDelete = values.items.slice(0, 2).map(v => v.id);
+     *
+     * await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
+     * ```
+     * @internal
+     */
+    deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
 }
 
 declare class ChoiceSetService extends BaseService implements ChoiceSetServiceModel {
@@ -2469,7 +2635,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
      *
      * @example
      * ```typescript
-     * import { ChoiceSets } from '@uipath/uipath-typescript/choicesets';
+     * import { ChoiceSets } from '@uipath/uipath-typescript/entities';
      *
      * const choiceSets = new ChoiceSets(sdk);
      *
@@ -2496,7 +2662,140 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
      * ```
      */
     getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
+    /**
+     * Creates a new Data Fabric choice set
+     *
+     * @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})
+     * @returns Promise resolving to the UUID of the created choice set
+     *
+     * @example
+     * ```typescript
+     * import { ChoiceSets } from '@uipath/uipath-typescript/entities';
+     *
+     * const choicesets = new ChoiceSets(sdk);
+     *
+     * // Minimal create
+     * const expenseTypesId = await choicesets.create("expense_types");
+     *
+     * // With display name and description
+     * const priorityLevelsId = await choicesets.create("priority_levels", {
+     *   displayName: "Priority Levels",
+     *   description: "Ticket priority categories",
+     * });
+     * ```
+     * @internal
+     */
+    create(name: string, options?: ChoiceSetCreateOptions): Promise<string>;
+    /**
+     * Updates an existing choice set's metadata (display name and/or description).
+     *
+     * **At least one of `displayName` or `description` must be provided** —
+     * 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})
+     * @returns Promise resolving when the update is complete
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.updateById(expenseTypes.id, {
+     *   displayName: "Expense Categories",
+     *   description: "Updated description",
+     * });
+     * ```
+     * @internal
+     */
+    updateById(choiceSetId: string, options: ChoiceSetUpdateOptions): Promise<void>;
+    /**
+     * Deletes a Data Fabric choice set and all its values.
+     *
+     * @param choiceSetId - UUID of the choice set to delete
+     * @returns Promise resolving when the choice set is deleted
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.deleteById(expenseTypes.id);
+     * ```
+     * @internal
+     */
+    deleteById(choiceSetId: string): Promise<void>;
+    /**
+     * 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})
+     * @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * const inserted = await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
+     *   displayName: 'Travel',
+     * });
+     * console.log(inserted.id);
+     * ```
+     * @internal
+     */
+    insertValueById(choiceSetId: string, name: string, options?: ChoiceSetValueInsertOptions): Promise<ChoiceSetValueInsertResponse>;
+    /**
+     * Updates an existing choice-set value's display name.
+     *
+     * Only `displayName` is mutable; the value's `name` (identifier) is fixed at
+     * insert time and cannot be changed.
+     *
+     * @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
+     * @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
+     *
+     * @example
+     * ```typescript
+     * // Get the choice set ID from getAll() and the value ID from getById()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     * const values = await choicesets.getById(expenseTypes.id);
+     * const travel = values.items.find(v => v.name === 'TRAVEL');
+     *
+     * await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
+     * ```
+     * @internal
+     */
+    updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
+    /**
+     * Deletes one or more values from a choice set.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param valueIds - Array of value UUIDs to delete
+     * @returns Promise resolving when the values are deleted
+     *
+     * @example
+     * ```typescript
+     * // Get the value IDs from getById()
+     * const values = await choicesets.getById('<choiceSetId>');
+     * const idsToDelete = values.items.slice(0, 2).map(v => v.id);
+     *
+     * await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
+     * ```
+     * @internal
+     */
+    deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
+    private resolveChoiceSetName;
 }
 
 export { ChoiceSetService, ChoiceSetService as ChoiceSets, DataDirectionType, EntityService as Entities, EntityAggregateFunction, EntityFieldDataType, EntityService, EntityType, FieldDisplayType, JoinType, LogicalOperator, QueryFilterOperator, ReferenceType, createEntityWithMethods };
-export type { ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, RawEntityGetResponse, SourceJoinCriteria, SqlType };
+export type { ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, FailureRecord, Field, FieldDataType, FieldMetaData, RawEntityGetResponse, SourceJoinCriteria, SqlType };