@uipath/uipath-typescript 1.5.0 → 1.5.1

package/dist/entities/index.d.ts

@@ -3129,5 +3129,445 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
     private resolveChoiceSetName;
 }
 
-export { ChoiceSetService, ChoiceSetService as ChoiceSets, DataDirectionType, EntityService as Entities, EntityAggregateFunction, EntityFieldDataType, EntityService, EntityType, FieldDisplayType, JoinType, LogicalOperator, QueryFilterOperator, ReferenceType, createEntityWithMethods };
+/**
+ * @internal
+ */
+declare enum DataFabricRoleType {
+    System = "System",
+    UserDefined = "UserDefined"
+}
+/**
+ * @internal
+ */
+interface DataFabricRole {
+    id: string;
+    name: string;
+    type: DataFabricRoleType;
+    directoryEntityCount?: number | null;
+    folderId?: string;
+}
+/**
+ * @internal
+ */
+interface DataFabricRoleGetAllOptions {
+    /**
+     * Include role statistics in the response.
+     *
+     * Defaults to true to match the Data Fabric UI and CLI role-list flow.
+     */
+    stats?: boolean;
+    /**
+     * Optional folder key for folder-aware Role V2 requests.
+     *
+     * Forwarded on the wire as the `X-UIPATH-FolderKey` header.
+     */
+    folderKey?: string;
+}
+
+/**
+ * @internal
+ */
+interface DataFabricRoleServiceModel {
+    /**
+     * Lists Data Fabric access roles.
+     *
+     * Returns tenant Data Fabric roles such as Admin, Designer, DataWriter, and
+     * DataReader. Role IDs from this method can be passed to
+     * `DataFabricDirectoryService.assignRoles()`.
+     *
+     * @param options - Optional query options
+     * @returns Promise resolving to an array of {@link DataFabricRole}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricRoleService } from '@uipath/uipath-typescript/entities';
+     *
+     * const roles = new DataFabricRoleService(sdk);
+     * const allRoles = await roles.getAll();
+     * const dataWriter = allRoles.find(role => role.name === 'DataWriter');
+     * ```
+     *
+     * @example
+     * ```typescript
+     * const rolesWithoutStats = await roles.getAll({ stats: false });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * const folderRoles = await roles.getAll({ folderKey: '<folder-key>' });
+     * ```
+     *
+     * @internal
+     */
+    getAll(options?: DataFabricRoleGetAllOptions): Promise<DataFabricRole[]>;
+}
+
+/**
+ * @internal
+ */
+declare class DataFabricRoleService extends BaseService implements DataFabricRoleServiceModel {
+    /**
+     * Lists Data Fabric access roles.
+     *
+     * Returns tenant Data Fabric roles such as Admin, Designer, DataWriter, and
+     * DataReader. Role IDs from this method can be passed to
+     * `DataFabricDirectoryService.assignRoles()`.
+     *
+     * @param options - Optional query options
+     * @returns Promise resolving to an array of {@link DataFabricRole}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricRoleService } from '@uipath/uipath-typescript/entities';
+     *
+     * const roles = new DataFabricRoleService(sdk);
+     * const allRoles = await roles.getAll();
+     * const dataWriter = allRoles.find(role => role.name === 'DataWriter');
+     * ```
+     *
+     * @example
+     * ```typescript
+     * const rolesWithoutStats = await roles.getAll({ stats: false });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * const folderRoles = await roles.getAll({ folderKey: '<folder-key>' });
+     * ```
+     *
+     * @internal
+     */
+    getAll(options?: DataFabricRoleGetAllOptions): Promise<DataFabricRole[]>;
+}
+
+/**
+ * @internal
+ */
+declare enum DataFabricDirectoryEntityType {
+    /** Identity user, robot user, or directory robot principal. */
+    User = 0,
+    /** Identity group principal. */
+    Group = 1,
+    /** External application principal. */
+    Application = 2
+}
+/**
+ * @internal
+ */
+declare enum DataFabricDirectoryEntityTypeName {
+    User = "User",
+    Group = "Group",
+    Application = "Application"
+}
+/**
+ * @internal
+ */
+type DataFabricDirectoryEntityTypeInput = DataFabricDirectoryEntityType | DataFabricDirectoryEntityTypeName;
+/**
+ * @internal
+ */
+interface DataFabricDirectoryRole {
+    id: string;
+    name: string;
+}
+/**
+ * @internal
+ */
+interface DataFabricDirectoryEntry {
+    externalId: string;
+    name: string;
+    email?: string | null;
+    type: DataFabricDirectoryEntityTypeName;
+    roles: DataFabricDirectoryRole[];
+    objectType?: string | null;
+    isUIEnabled: boolean;
+}
+/**
+ * @internal
+ */
+interface DataFabricDirectoryListOptions {
+    skip?: number;
+    top?: number;
+}
+/**
+ * @internal
+ */
+interface DataFabricDirectoryGetAllOptions {
+    pageSize?: number;
+}
+/**
+ * @internal
+ */
+interface DataFabricDirectoryListResponse {
+    totalCount: number;
+    results: DataFabricDirectoryEntry[];
+}
+/**
+ * @internal
+ */
+interface DataFabricDirectoryAssignOptions {
+    /**
+     * Preserve the principal's current Data Fabric roles.
+     *
+     * Defaults to true because the Data Fabric role assignment endpoint replaces
+     * the role set for each principal.
+     */
+    preserveExisting?: boolean;
+    /**
+     * Enables Data Fabric UI access for the assigned principal.
+     *
+     * Defaults to true.
+     */
+    uiEnabled?: boolean;
+}
+/**
+ * @internal
+ */
+interface DataFabricDirectoryAssignmentResult {
+    principalId: string;
+    roleIds: string[];
+}
+
+/**
+ * @internal
+ */
+interface DataFabricDirectoryServiceModel {
+    /**
+     * Lists one page of Data Fabric directory principals and their current roles.
+     *
+     * Returns directory entries with external IDs, principal metadata, and
+     * assigned Data Fabric roles.
+     *
+     * @param options - Optional offset paging options
+     * @returns Promise resolving to {@link DataFabricDirectoryListResponse}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
+     *
+     * const directory = new DataFabricDirectoryService(sdk);
+     * const page = await directory.list({ skip: 0, top: 50 });
+     * const firstPrincipal = page.results[0];
+     * ```
+     *
+     * @internal
+     */
+    list(options?: DataFabricDirectoryListOptions): Promise<DataFabricDirectoryListResponse>;
+    /**
+     * Lists all Data Fabric directory principals and their current roles.
+     *
+     * Follows the Data Fabric directory top/skip pagination and returns
+     * normalized entries. Entries without assigned roles include an empty
+     * `roles` array.
+     *
+     * @param options - Optional page-size options
+     * @returns Promise resolving to an array of {@link DataFabricDirectoryEntry}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
+     *
+     * const directory = new DataFabricDirectoryService(sdk);
+     * const principals = await directory.getAll({ pageSize: 100 });
+     * ```
+     *
+     * @internal
+     */
+    getAll(options?: DataFabricDirectoryGetAllOptions): Promise<DataFabricDirectoryEntry[]>;
+    /**
+     * Assigns Data Fabric roles to one or more principals.
+     *
+     * The Data Fabric API replaces the role set for each principal, so this
+     * method preserves existing roles by default and posts the union of current
+     * and requested role IDs.
+     *
+     * Role IDs can be discovered with `DataFabricRoleService.getAll()`. Set
+     * `preserveExisting: false` only when intentionally replacing a principal's
+     * Data Fabric role set.
+     *
+     * @param principalIds - Principal external ID or IDs
+     * @param principalType - Principal type
+     * @param roleIds - Data Fabric role IDs to assign
+     * @param options - Optional assignment behavior
+     * @returns Promise resolving to an array of {@link DataFabricDirectoryAssignmentResult}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryEntityTypeName, DataFabricDirectoryService, DataFabricRoleService } from '@uipath/uipath-typescript/entities';
+     *
+     * const roles = new DataFabricRoleService(sdk);
+     * const directory = new DataFabricDirectoryService(sdk);
+     *
+     * const dataWriter = (await roles.getAll()).find(role => role.name === 'DataWriter');
+     * if (!dataWriter) {
+     *   throw new Error('DataWriter role not found');
+     * }
+     *
+     * await directory.assignRoles('<identity-group-id>', DataFabricDirectoryEntityTypeName.Group, [dataWriter.id]);
+     * ```
+     *
+     * @example
+     * ```typescript
+     * await directory.assignRoles('<identity-user-id>', DataFabricDirectoryEntityTypeName.User, ['<role-id>'], {
+     *   preserveExisting: false,
+     * });
+     * ```
+     *
+     * @internal
+     */
+    assignRoles(principalIds: string | string[], principalType: DataFabricDirectoryEntityTypeInput, roleIds: string[], options?: DataFabricDirectoryAssignOptions): Promise<DataFabricDirectoryAssignmentResult[]>;
+    /**
+     * Revokes all direct Data Fabric roles from one or more principals.
+     *
+     * The Data Fabric API removes all role assignments for each supplied external
+     * ID. Use this when a principal should no longer have direct Data Fabric
+     * access. Inherited access through groups is not changed.
+     *
+     * @param principalIds - Principal external ID or IDs
+     * @returns Promise resolving when the roles are revoked
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
+     *
+     * const directory = new DataFabricDirectoryService(sdk);
+     *
+     * await directory.revokeRoles('<identity-user-id>');
+     * ```
+     *
+     * @example
+     * ```typescript
+     * await directory.revokeRoles([
+     *   '<identity-user-id>',
+     *   '<identity-group-id>',
+     * ]);
+     * ```
+     *
+     * @internal
+     */
+    revokeRoles(principalIds: string | string[]): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+declare class DataFabricDirectoryService extends BaseService implements DataFabricDirectoryServiceModel {
+    private fetchAllEntries;
+    /**
+     * Lists one page of Data Fabric directory principals and their current roles.
+     *
+     * Returns directory entries with external IDs, principal metadata, and
+     * assigned Data Fabric roles.
+     *
+     * @param options - Optional offset paging options
+     * @returns Promise resolving to {@link DataFabricDirectoryListResponse}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
+     *
+     * const directory = new DataFabricDirectoryService(sdk);
+     * const page = await directory.list({ skip: 0, top: 50 });
+     * const firstPrincipal = page.results[0];
+     * ```
+     *
+     * @internal
+     */
+    list(options?: DataFabricDirectoryListOptions): Promise<DataFabricDirectoryListResponse>;
+    /**
+     * Lists all Data Fabric directory principals and their current roles.
+     *
+     * Follows the Data Fabric directory top/skip pagination and returns
+     * normalized entries. Entries without assigned roles include an empty
+     * `roles` array.
+     *
+     * @param options - Optional page-size options
+     * @returns Promise resolving to an array of {@link DataFabricDirectoryEntry}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
+     *
+     * const directory = new DataFabricDirectoryService(sdk);
+     * const principals = await directory.getAll({ pageSize: 100 });
+     * ```
+     *
+     * @internal
+     */
+    getAll(options?: DataFabricDirectoryGetAllOptions): Promise<DataFabricDirectoryEntry[]>;
+    /**
+     * Assigns Data Fabric roles to one or more principals.
+     *
+     * The Data Fabric API replaces the role set for each principal, so this
+     * method preserves existing roles by default and posts the union of current
+     * and requested role IDs.
+     *
+     * Role IDs can be discovered with `DataFabricRoleService.getAll()`. Set
+     * `preserveExisting: false` only when intentionally replacing a principal's
+     * Data Fabric role set.
+     *
+     * @param principalIds - Principal external ID or IDs
+     * @param principalType - Principal type
+     * @param roleIds - Data Fabric role IDs to assign
+     * @param options - Optional assignment behavior
+     * @returns Promise resolving to an array of {@link DataFabricDirectoryAssignmentResult}
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryEntityTypeName, DataFabricDirectoryService, DataFabricRoleService } from '@uipath/uipath-typescript/entities';
+     *
+     * const roles = new DataFabricRoleService(sdk);
+     * const directory = new DataFabricDirectoryService(sdk);
+     *
+     * const dataWriter = (await roles.getAll()).find(role => role.name === 'DataWriter');
+     * if (!dataWriter) {
+     *   throw new Error('DataWriter role not found');
+     * }
+     *
+     * await directory.assignRoles('<identity-group-id>', DataFabricDirectoryEntityTypeName.Group, [dataWriter.id]);
+     * ```
+     *
+     * @example
+     * ```typescript
+     * await directory.assignRoles('<identity-user-id>', DataFabricDirectoryEntityTypeName.User, ['<role-id>'], {
+     *   preserveExisting: false,
+     * });
+     * ```
+     *
+     * @internal
+     */
+    assignRoles(principalIds: string | string[], principalType: DataFabricDirectoryEntityTypeInput, roleIds: string[], options?: DataFabricDirectoryAssignOptions): Promise<DataFabricDirectoryAssignmentResult[]>;
+    /**
+     * Revokes all direct Data Fabric roles from one or more principals.
+     *
+     * The Data Fabric API removes all role assignments for each supplied external
+     * ID. Use this when a principal should no longer have direct Data Fabric
+     * access. Inherited access through groups is not changed.
+     *
+     * @param principalIds - Principal external ID or IDs
+     * @returns Promise resolving when the roles are revoked
+     *
+     * @example
+     * ```typescript
+     * import { DataFabricDirectoryService } from '@uipath/uipath-typescript/entities';
+     *
+     * const directory = new DataFabricDirectoryService(sdk);
+     *
+     * await directory.revokeRoles('<identity-user-id>');
+     * ```
+     *
+     * @example
+     * ```typescript
+     * await directory.revokeRoles([
+     *   '<identity-user-id>',
+     *   '<identity-group-id>',
+     * ]);
+     * ```
+     *
+     * @internal
+     */
+    revokeRoles(principalIds: string | string[]): Promise<void>;
+}
+
+export { ChoiceSetService, ChoiceSetService as ChoiceSets, DataDirectionType, DataFabricDirectoryService, DataFabricRoleService, EntityService as Entities, EntityAggregateFunction, EntityFieldDataType, EntityService, EntityType, FieldDisplayType, JoinType, LogicalOperator, QueryFilterOperator, ReferenceType, createEntityWithMethods };
 export type { ChoiceSetCreateOptions, ChoiceSetDeleteByIdOptions, ChoiceSetGetAllOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueDeleteOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateOptions, ChoiceSetValueUpdateResponse, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentOptions, EntityDeleteAttachmentResponse, EntityDeleteByIdOptions, EntityDeleteOptions, EntityDeleteRecordByIdOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityDownloadAttachmentOptions, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityFolderScopedOptions, EntityGetAllOptions, EntityGetAllRecordsOptions, EntityGetByIdOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsByIdOptions, 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 };