@uipath/uipath-typescript 1.3.10 → 1.3.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -4598,6 +4598,8 @@ const MAESTRO_ENDPOINTS = {
4598
4598
  TOP_PROCESSES_BY_RUN_COUNT: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/TopProcessesByRunCount`,
4599
4599
  /** Top processes ranked by failure count */
4600
4600
  TOP_PROCESSES_WITH_FAILURE: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/TopProcesseswithFailure`,
4601
+ /** Top elements ranked by failure count */
4602
+ TOP_ELEMENTS_WITH_FAILURE: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/TopElementswithFailure`,
4601
4603
  /** Instance status aggregated by date for time-series charts */
4602
4604
  INSTANCE_STATUS_BY_DATE: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/InstanceStatusByDate`,
4603
4605
  /** Top processes ranked by total duration */
@@ -5492,7 +5494,7 @@ function normalizeBaseUrl(url) {
5492
5494
  * SDK's public API.
5493
5495
  */
5494
5496
  /** SDK version placeholder — patched by the SDK publish workflow. */
5495
- const SDK_VERSION = '1.3.10';
5497
+ const SDK_VERSION = '1.3.11';
5496
5498
  const CLOUD_ROLE_NAME = 'uipath-ts-sdk';
5497
5499
  const SDK_SERVICE_NAME = 'UiPath.TypeScript.Sdk';
5498
5500
  const SDK_LOGGER_NAME = 'uipath-ts-sdk-telemetry';
@@ -8538,10 +8540,6 @@ class EntityService extends BaseService {
8538
8540
  * @internal
8539
8541
  */
8540
8542
  async create(name, fields, options) {
8541
- this.validateName(name, 'entity');
8542
- for (const field of fields) {
8543
- this.validateName(field.fieldName, 'field');
8544
- }
8545
8543
  const opts = options ?? {};
8546
8544
  const payload = {
8547
8545
  ...(opts.description !== undefined && { description: opts.description }),
@@ -8684,6 +8682,7 @@ class EntityService extends BaseService {
8684
8682
  ...(update.isUnique !== undefined && { isUnique: update.isUnique }),
8685
8683
  ...(update.isRbacEnabled !== undefined && { isRbacEnabled: update.isRbacEnabled }),
8686
8684
  ...(update.isEncrypted !== undefined && { isEncrypted: update.isEncrypted }),
8685
+ ...(update.isHiddenField !== undefined && { isHiddenField: update.isHiddenField }),
8687
8686
  ...(update.defaultValue !== undefined && { defaultValue: update.defaultValue }),
8688
8687
  ...(hasConstraintUpdate && f.sqlType && { sqlType: { ...f.sqlType, ...constraintUpdate } }),
8689
8688
  };
@@ -8692,9 +8691,6 @@ class EntityService extends BaseService {
8692
8691
  // Build and append new fields
8693
8692
  const newFields = [];
8694
8693
  if (options.addFields?.length) {
8695
- for (const field of options.addFields) {
8696
- this.validateName(field.fieldName, 'field');
8697
- }
8698
8694
  newFields.push(...options.addFields.map(f => this.buildSchemaFieldPayload(f)));
8699
8695
  }
8700
8696
  await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPSERT, {
@@ -8795,9 +8791,15 @@ class EntityService extends BaseService {
8795
8791
  }
8796
8792
  /** Converts a user-facing EntityCreateFieldOptions to the raw API field payload */
8797
8793
  buildSchemaFieldPayload(field) {
8798
- this.validateName(field.fieldName, 'field');
8799
8794
  const fieldType = field.type ?? exports.EntityFieldDataType.STRING;
8800
8795
  this.validateFieldConstraints(fieldType, field, field.fieldName);
8796
+ const isRelationship = fieldType === exports.EntityFieldDataType.RELATIONSHIP;
8797
+ const isFile = fieldType === exports.EntityFieldDataType.FILE;
8798
+ if ((isRelationship || isFile) && (!field.referenceEntityId || !field.referenceFieldId)) {
8799
+ throw new ValidationError({
8800
+ message: `Field '${field.fieldName}' of type ${fieldType} requires both referenceEntityId and referenceFieldId (UUIDs of the target entity and field).`,
8801
+ });
8802
+ }
8801
8803
  const mapping = EntitySchemaFieldTypeMap[fieldType];
8802
8804
  return {
8803
8805
  name: field.fieldName,
@@ -8812,10 +8814,13 @@ class EntityService extends BaseService {
8812
8814
  isUnique: field.isUnique ?? false,
8813
8815
  isRbacEnabled: field.isRbacEnabled ?? false,
8814
8816
  isEncrypted: field.isEncrypted ?? false,
8817
+ isHiddenField: field.isHiddenField ?? false,
8815
8818
  ...(field.defaultValue !== undefined && { defaultValue: field.defaultValue }),
8816
8819
  ...(field.choiceSetId !== undefined && { choiceSetId: field.choiceSetId }),
8817
- ...(field.referenceEntityName !== undefined && { referenceEntityName: field.referenceEntityName }),
8818
- ...(field.referenceFieldName !== undefined && { referenceFieldName: field.referenceFieldName }),
8820
+ ...((isRelationship || isFile) && { isForeignKey: true }),
8821
+ ...(isRelationship && { referenceType: exports.ReferenceType.ManyToOne }),
8822
+ ...(field.referenceEntityId !== undefined && { referenceEntity: { id: field.referenceEntityId } }),
8823
+ ...(field.referenceFieldId !== undefined && { referenceField: { id: field.referenceFieldId } }),
8819
8824
  };
8820
8825
  }
8821
8826
  /**
@@ -8919,24 +8924,7 @@ class EntityService extends BaseService {
8919
8924
  return {};
8920
8925
  }
8921
8926
  }
8922
- validateName(name, context) {
8923
- if (name.length < 3 || name.length > 100 || !/^[a-zA-Z]\w*$/.test(name)) {
8924
- const suggestion = name.replace(/\W/g, '').replace(/^[0-9_]+/, '');
8925
- const defaultName = `My${context.charAt(0).toUpperCase() + context.slice(1)}`;
8926
- throw new ValidationError({
8927
- message: `Invalid ${context} name '${name}'. Must start with a letter, contain only letters, numbers, and underscores, 3–100 characters (e.g., "${suggestion || defaultName}").`
8928
- });
8929
- }
8930
- if (context === 'field' && EntityService.RESERVED_FIELD_NAMES.has(name)) {
8931
- throw new ValidationError({
8932
- message: `Field name '${name}' is reserved. Reserved names: ${[...EntityService.RESERVED_FIELD_NAMES].join(', ')}.`
8933
- });
8934
- }
8935
- }
8936
8927
  }
8937
- EntityService.RESERVED_FIELD_NAMES = new Set([
8938
- 'Id', 'CreatedBy', 'CreateTime', 'UpdatedBy', 'UpdateTime'
8939
- ]);
8940
8928
  __decorate([
8941
8929
  track('Entities.GetById')
8942
8930
  ], EntityService.prototype, "getById", null);
@@ -10217,6 +10205,52 @@ class MaestroProcessesService extends BaseService {
10217
10205
  const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.TOP_PROCESSES_BY_RUN_COUNT, buildInsightsTopBody(startTime, endTime, false, options));
10218
10206
  return (data ?? []).map(process => ({ ...process, name: process.packageId }));
10219
10207
  }
10208
+ /**
10209
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
10210
+ *
10211
+ * Returns an array of up to 10 elements sorted by how many times they failed,
10212
+ * useful for identifying the most error-prone activities in processes.
10213
+ *
10214
+ * @param startTime - Start of the time range to query
10215
+ * @param endTime - End of the time range to query
10216
+ * @param options - Optional filters (packageId, processKey, version)
10217
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
10218
+ * @example
10219
+ * ```typescript
10220
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
10221
+ *
10222
+ * const maestroProcesses = new MaestroProcesses(sdk);
10223
+ *
10224
+ * // Get top failing elements for the last 7 days
10225
+ * const topFailing = await maestroProcesses.getTopElementFailedCount(
10226
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
10227
+ * new Date()
10228
+ * );
10229
+ *
10230
+ * for (const element of topFailing) {
10231
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
10232
+ * }
10233
+ * ```
10234
+ *
10235
+ * @example
10236
+ * ```typescript
10237
+ * // Get top failing elements for a specific process
10238
+ * const filtered = await maestroProcesses.getTopElementFailedCount(
10239
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
10240
+ * new Date(),
10241
+ * { processKey: '<processKey>' }
10242
+ * );
10243
+ * ```
10244
+ */
10245
+ async getTopElementFailedCount(startTime, endTime, options) {
10246
+ const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.TOP_ELEMENTS_WITH_FAILURE, buildInsightsTopBody(startTime, endTime, false, options));
10247
+ return (data ?? []).map(item => ({
10248
+ elementName: item.elementName,
10249
+ elementType: item.elementType,
10250
+ processKey: item.processKey,
10251
+ failedCount: item.count,
10252
+ }));
10253
+ }
10220
10254
  /**
10221
10255
  * Get all instances status counts aggregated by date for maestro processes.
10222
10256
  *
@@ -10357,6 +10391,9 @@ __decorate([
10357
10391
  __decorate([
10358
10392
  track('MaestroProcesses.GetTopRunCount')
10359
10393
  ], MaestroProcessesService.prototype, "getTopRunCount", null);
10394
+ __decorate([
10395
+ track('MaestroProcesses.GetTopElementFailedCount')
10396
+ ], MaestroProcessesService.prototype, "getTopElementFailedCount", null);
10360
10397
  __decorate([
10361
10398
  track('MaestroProcesses.GetInstanceStatusTimeline')
10362
10399
  ], MaestroProcessesService.prototype, "getInstanceStatusTimeline", null);
@@ -10491,6 +10528,52 @@ class CasesService extends BaseService {
10491
10528
  const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.TOP_PROCESSES_BY_RUN_COUNT, buildInsightsTopBody(startTime, endTime, true, options));
10492
10529
  return (data ?? []).map(process => ({ ...process, name: this.extractCaseName(process.packageId) }));
10493
10530
  }
10531
+ /**
10532
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
10533
+ *
10534
+ * Returns an array of up to 10 elements sorted by how many times they failed,
10535
+ * useful for identifying the most error-prone activities in case processes.
10536
+ *
10537
+ * @param startTime - Start of the time range to query
10538
+ * @param endTime - End of the time range to query
10539
+ * @param options - Optional filters (packageId, processKey, version)
10540
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
10541
+ * @example
10542
+ * ```typescript
10543
+ * import { Cases } from '@uipath/uipath-typescript/cases';
10544
+ *
10545
+ * const cases = new Cases(sdk);
10546
+ *
10547
+ * // Get top failing elements for the last 7 days
10548
+ * const topFailing = await cases.getTopElementFailedCount(
10549
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
10550
+ * new Date()
10551
+ * );
10552
+ *
10553
+ * for (const element of topFailing) {
10554
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
10555
+ * }
10556
+ * ```
10557
+ *
10558
+ * @example
10559
+ * ```typescript
10560
+ * // Get top failing elements for a specific process
10561
+ * const filtered = await cases.getTopElementFailedCount(
10562
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
10563
+ * new Date(),
10564
+ * { processKey: '<processKey>' }
10565
+ * );
10566
+ * ```
10567
+ */
10568
+ async getTopElementFailedCount(startTime, endTime, options) {
10569
+ const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.TOP_ELEMENTS_WITH_FAILURE, buildInsightsTopBody(startTime, endTime, true, options));
10570
+ return (data ?? []).map(item => ({
10571
+ elementName: item.elementName,
10572
+ elementType: item.elementType,
10573
+ processKey: item.processKey,
10574
+ failedCount: item.count,
10575
+ }));
10576
+ }
10494
10577
  /**
10495
10578
  * Get all instances status counts aggregated by date for case management processes.
10496
10579
  *
@@ -10646,6 +10729,9 @@ __decorate([
10646
10729
  __decorate([
10647
10730
  track('Cases.GetTopRunCount')
10648
10731
  ], CasesService.prototype, "getTopRunCount", null);
10732
+ __decorate([
10733
+ track('Cases.GetTopElementFailedCount')
10734
+ ], CasesService.prototype, "getTopElementFailedCount", null);
10649
10735
  __decorate([
10650
10736
  track('Cases.GetInstanceStatusTimeline')
10651
10737
  ], CasesService.prototype, "getInstanceStatusTimeline", null);
package/dist/index.d.ts CHANGED
@@ -722,6 +722,8 @@ interface EntityFieldBase {
722
722
  isRbacEnabled?: boolean;
723
723
  /** Whether the field value is encrypted at rest (default: false) */
724
724
  isEncrypted?: boolean;
725
+ /** Whether the field is hidden from the UI (default: false) */
726
+ isHiddenField?: boolean;
725
727
  /** Default value for the field */
726
728
  defaultValue?: string;
727
729
  /** Maximum character length for STRING fields (default: 200, range: 1–4000) and MULTILINE_TEXT fields (default: 200, range: 1–10000). */
@@ -746,10 +748,10 @@ interface EntityCreateFieldOptions extends EntityFieldBase {
746
748
  type?: EntityFieldDataType;
747
749
  /** Choice set ID for choice-set fields */
748
750
  choiceSetId?: string;
749
- /** Name of the referenced entity for relationship fields */
750
- referenceEntityName?: string;
751
- /** Name of the field in the referenced entity */
752
- referenceFieldName?: string;
751
+ /** UUID of the referenced entity (required when `type` is `RELATIONSHIP` or `FILE`) */
752
+ referenceEntityId?: string;
753
+ /** UUID of the referenced field on the target entity (required when `type` is `RELATIONSHIP` or `FILE`) */
754
+ referenceFieldId?: string;
753
755
  }
754
756
  /**
755
757
  * Options for creating a new Data Fabric entity
@@ -979,10 +981,6 @@ interface FieldMetaData {
979
981
  referenceType?: ReferenceType;
980
982
  choiceSetId?: string;
981
983
  defaultValue?: string;
982
- /** Name of the referenced entity (used on write payloads for relationship fields) */
983
- referenceEntityName?: string;
984
- /** Name of the field in the referenced entity (used on write payloads for relationship fields) */
985
- referenceFieldName?: string;
986
984
  }
987
985
  /**
988
986
  * External object details
@@ -2469,8 +2467,6 @@ declare class EntityService extends BaseService implements EntityServiceModel {
2469
2467
  * override the defaults where the type accepts overrides.
2470
2468
  */
2471
2469
  private buildSqlTypeConstraints;
2472
- private static readonly RESERVED_FIELD_NAMES;
2473
- private validateName;
2474
2470
  }
2475
2471
 
2476
2472
  /**
@@ -3013,6 +3009,20 @@ interface GetTopFaultedCountResponse extends GetTopBaseResponse {
3013
3009
  /** Number of faulted instances in the given time range */
3014
3010
  faultedCount: number;
3015
3011
  }
3012
+ /**
3013
+ * SDK response for top elements with failure.
3014
+ * Shared by both MaestroProcesses and Cases — no service-specific enrichment.
3015
+ */
3016
+ interface ElementGetTopFailedCountResponse {
3017
+ /** BPMN element name (falls back to element ID if name is empty) */
3018
+ elementName: string;
3019
+ /** BPMN element type (e.g. ServiceTask, ReceiveTask, IntermediateCatchEvent) */
3020
+ elementType: string;
3021
+ /** The unique process key this element belongs to */
3022
+ processKey: string;
3023
+ /** Number of failed executions of this element in the given time range */
3024
+ failedCount: number;
3025
+ }
3016
3026
  /**
3017
3027
  * Time bucketing granularity for insights time-series queries.
3018
3028
  *
@@ -3338,6 +3348,44 @@ interface MaestroProcessesServiceModel {
3338
3348
  * ```
3339
3349
  */
3340
3350
  getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopFaultedCountResponse[]>;
3351
+ /**
3352
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
3353
+ *
3354
+ * Returns an array of up to 10 elements sorted by how many times they failed,
3355
+ * useful for identifying the most error-prone activities in processes.
3356
+ *
3357
+ * @param startTime - Start of the time range to query
3358
+ * @param endTime - End of the time range to query
3359
+ * @param options - Optional filters (packageId, processKey, version)
3360
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
3361
+ * @example
3362
+ * ```typescript
3363
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
3364
+ *
3365
+ * const maestroProcesses = new MaestroProcesses(sdk);
3366
+ *
3367
+ * // Get top failing elements for the last 7 days
3368
+ * const topFailing = await maestroProcesses.getTopElementFailedCount(
3369
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3370
+ * new Date()
3371
+ * );
3372
+ *
3373
+ * for (const element of topFailing) {
3374
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
3375
+ * }
3376
+ * ```
3377
+ *
3378
+ * @example
3379
+ * ```typescript
3380
+ * // Get top failing elements for a specific process
3381
+ * const filtered = await maestroProcesses.getTopElementFailedCount(
3382
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
3383
+ * new Date(),
3384
+ * { processKey: '<processKey>' }
3385
+ * );
3386
+ * ```
3387
+ */
3388
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
3341
3389
  /**
3342
3390
  * Get all instances status counts aggregated by date for maestro processes.
3343
3391
  *
@@ -4132,6 +4180,44 @@ interface CasesServiceModel {
4132
4180
  * ```
4133
4181
  */
4134
4182
  getTopFaultedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopFaultedCountResponse[]>;
4183
+ /**
4184
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
4185
+ *
4186
+ * Returns an array of up to 10 elements sorted by how many times they failed,
4187
+ * useful for identifying the most error-prone activities in case processes.
4188
+ *
4189
+ * @param startTime - Start of the time range to query
4190
+ * @param endTime - End of the time range to query
4191
+ * @param options - Optional filters (packageId, processKey, version)
4192
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
4193
+ * @example
4194
+ * ```typescript
4195
+ * import { Cases } from '@uipath/uipath-typescript/cases';
4196
+ *
4197
+ * const cases = new Cases(sdk);
4198
+ *
4199
+ * // Get top failing elements for the last 7 days
4200
+ * const topFailing = await cases.getTopElementFailedCount(
4201
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
4202
+ * new Date()
4203
+ * );
4204
+ *
4205
+ * for (const element of topFailing) {
4206
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
4207
+ * }
4208
+ * ```
4209
+ *
4210
+ * @example
4211
+ * ```typescript
4212
+ * // Get top failing elements for a specific process
4213
+ * const filtered = await cases.getTopElementFailedCount(
4214
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
4215
+ * new Date(),
4216
+ * { processKey: '<processKey>' }
4217
+ * );
4218
+ * ```
4219
+ */
4220
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
4135
4221
  /**
4136
4222
  * Get all instances status counts aggregated by date for case management processes.
4137
4223
  *
@@ -5578,6 +5664,44 @@ declare class MaestroProcessesService extends BaseService implements MaestroProc
5578
5664
  * ```
5579
5665
  */
5580
5666
  getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ProcessGetTopRunCountResponse[]>;
5667
+ /**
5668
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
5669
+ *
5670
+ * Returns an array of up to 10 elements sorted by how many times they failed,
5671
+ * useful for identifying the most error-prone activities in processes.
5672
+ *
5673
+ * @param startTime - Start of the time range to query
5674
+ * @param endTime - End of the time range to query
5675
+ * @param options - Optional filters (packageId, processKey, version)
5676
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
5677
+ * @example
5678
+ * ```typescript
5679
+ * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
5680
+ *
5681
+ * const maestroProcesses = new MaestroProcesses(sdk);
5682
+ *
5683
+ * // Get top failing elements for the last 7 days
5684
+ * const topFailing = await maestroProcesses.getTopElementFailedCount(
5685
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5686
+ * new Date()
5687
+ * );
5688
+ *
5689
+ * for (const element of topFailing) {
5690
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
5691
+ * }
5692
+ * ```
5693
+ *
5694
+ * @example
5695
+ * ```typescript
5696
+ * // Get top failing elements for a specific process
5697
+ * const filtered = await maestroProcesses.getTopElementFailedCount(
5698
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
5699
+ * new Date(),
5700
+ * { processKey: '<processKey>' }
5701
+ * );
5702
+ * ```
5703
+ */
5704
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
5581
5705
  /**
5582
5706
  * Get all instances status counts aggregated by date for maestro processes.
5583
5707
  *
@@ -5912,6 +6036,44 @@ declare class CasesService extends BaseService implements CasesServiceModel {
5912
6036
  * ```
5913
6037
  */
5914
6038
  getTopRunCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopRunCountResponse[]>;
6039
+ /**
6040
+ * Get the top 10 BPMN elements ranked by failure count within a time range.
6041
+ *
6042
+ * Returns an array of up to 10 elements sorted by how many times they failed,
6043
+ * useful for identifying the most error-prone activities in case processes.
6044
+ *
6045
+ * @param startTime - Start of the time range to query
6046
+ * @param endTime - End of the time range to query
6047
+ * @param options - Optional filters (packageId, processKey, version)
6048
+ * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
6049
+ * @example
6050
+ * ```typescript
6051
+ * import { Cases } from '@uipath/uipath-typescript/cases';
6052
+ *
6053
+ * const cases = new Cases(sdk);
6054
+ *
6055
+ * // Get top failing elements for the last 7 days
6056
+ * const topFailing = await cases.getTopElementFailedCount(
6057
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
6058
+ * new Date()
6059
+ * );
6060
+ *
6061
+ * for (const element of topFailing) {
6062
+ * console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
6063
+ * }
6064
+ * ```
6065
+ *
6066
+ * @example
6067
+ * ```typescript
6068
+ * // Get top failing elements for a specific process
6069
+ * const filtered = await cases.getTopElementFailedCount(
6070
+ * new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
6071
+ * new Date(),
6072
+ * { processKey: '<processKey>' }
6073
+ * );
6074
+ * ```
6075
+ */
6076
+ getTopElementFailedCount(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<ElementGetTopFailedCountResponse[]>;
5915
6077
  /**
5916
6078
  * Get all instances status counts aggregated by date for case management processes.
5917
6079
  *
@@ -15550,4 +15712,4 @@ declare const telemetryClient: {
15550
15712
  };
15551
15713
 
15552
15714
  export { AgentMap, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CitationErrorType, ConversationGetAllFilterMap, ConversationMap, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, DataDirectionType, DebugMode, index as DuFramework, EntityAggregateFunction, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, ExchangeMap, FeedbackRating, FeedbackStatus, FieldDisplayType, HttpStatus, InputStreamSpeechSensitivity, InstanceFinalStatus, InstanceStatus, InterruptType, JobPriority, JobSourceType, JobState, JobSubState, JobType, JoinType, LogicalOperator$1 as LogicalOperator, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, QueryFilterOperator, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, RuntimeType, SLADurationUnit, ServerError, ServerlessJobType, SlaSummaryStatus, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, TimeInterval, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
15553
- export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketDeleteFileOptions, BucketFile, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetFilesOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, 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, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCategoryInput, FeedbackCategoryResponse, FeedbackCreateCategoryOptions, FeedbackCreateResponse, FeedbackDeleteCategoryOptions, FeedbackGetAllOptions, FeedbackGetCategoriesOptions, FeedbackGetResponse, FeedbackOptions, FeedbackResponse, FeedbackServiceModel, FeedbackSubmitOptions, FeedbackUpdateOptions, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, InstanceStatusTimelineResponse, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartOptions, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SlaSummaryResponse, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimelineOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, TopQueryOptions, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
15715
+ export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketDeleteFileOptions, BucketFile, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetFilesOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementGetTopFailedCountResponse, ElementMetaData, ElementRunMetadata, 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, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCategoryInput, FeedbackCategoryResponse, FeedbackCreateCategoryOptions, FeedbackCreateResponse, FeedbackDeleteCategoryOptions, FeedbackGetAllOptions, FeedbackGetCategoriesOptions, FeedbackGetResponse, FeedbackOptions, FeedbackResponse, FeedbackServiceModel, FeedbackSubmitOptions, FeedbackUpdateOptions, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, InstanceStatusTimelineResponse, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartOptions, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SlaSummaryResponse, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimelineOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, TopQueryOptions, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };