@uipath/uipath-typescript 1.2.1 → 1.3.0

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.
Files changed (40) hide show
  1. package/dist/assets/index.cjs +1 -1
  2. package/dist/assets/index.d.ts +2 -1
  3. package/dist/assets/index.mjs +1 -1
  4. package/dist/attachments/index.cjs +1944 -0
  5. package/dist/attachments/index.d.ts +399 -0
  6. package/dist/attachments/index.mjs +1941 -0
  7. package/dist/buckets/index.cjs +1 -1
  8. package/dist/buckets/index.d.ts +4 -2
  9. package/dist/buckets/index.mjs +1 -1
  10. package/dist/cases/index.cjs +95 -48
  11. package/dist/cases/index.d.ts +31 -2
  12. package/dist/cases/index.mjs +95 -48
  13. package/dist/conversational-agent/index.cjs +1 -1
  14. package/dist/conversational-agent/index.d.ts +10 -5
  15. package/dist/conversational-agent/index.mjs +1 -1
  16. package/dist/core/index.cjs +109 -17
  17. package/dist/core/index.d.ts +1 -1
  18. package/dist/core/index.mjs +109 -17
  19. package/dist/entities/index.cjs +11 -27
  20. package/dist/entities/index.d.ts +38 -26
  21. package/dist/entities/index.mjs +11 -27
  22. package/dist/index.cjs +683 -284
  23. package/dist/index.d.ts +549 -75
  24. package/dist/index.mjs +683 -285
  25. package/dist/index.umd.js +680 -281
  26. package/dist/jobs/index.cjs +2264 -0
  27. package/dist/jobs/index.d.ts +860 -0
  28. package/dist/jobs/index.mjs +2260 -0
  29. package/dist/maestro-processes/index.cjs +1 -1
  30. package/dist/maestro-processes/index.mjs +1 -1
  31. package/dist/processes/index.cjs +67 -1
  32. package/dist/processes/index.d.ts +80 -15
  33. package/dist/processes/index.mjs +68 -2
  34. package/dist/queues/index.cjs +1 -1
  35. package/dist/queues/index.d.ts +2 -1
  36. package/dist/queues/index.mjs +1 -1
  37. package/dist/tasks/index.cjs +1319 -1272
  38. package/dist/tasks/index.d.ts +331 -287
  39. package/dist/tasks/index.mjs +1319 -1272
  40. package/package.json +23 -2
@@ -4366,6 +4366,114 @@ function getErrorDetails(error) {
4366
4366
  };
4367
4367
  }
4368
4368
 
4369
+ /**
4370
+ * Types of tasks available in Action Center.
4371
+ * Each type determines the task's behavior, UI rendering, and completion requirements.
4372
+ */
4373
+ var TaskType;
4374
+ (function (TaskType) {
4375
+ /** A form-based task that renders a UiPath form layout for user input */
4376
+ TaskType["Form"] = "FormTask";
4377
+ /** An externally managed task handled outside of Action Center */
4378
+ TaskType["External"] = "ExternalTask";
4379
+ /** A task powered by a UiPath App */
4380
+ TaskType["App"] = "AppTask";
4381
+ /** A document validation task for reviewing and correcting extracted document data */
4382
+ TaskType["DocumentValidation"] = "DocumentValidationTask";
4383
+ /** A document classification task for categorizing documents */
4384
+ TaskType["DocumentClassification"] = "DocumentClassificationTask";
4385
+ /** A data labeling task for annotating training data */
4386
+ TaskType["DataLabeling"] = "DataLabelingTask";
4387
+ })(TaskType || (TaskType = {}));
4388
+ var TaskPriority;
4389
+ (function (TaskPriority) {
4390
+ TaskPriority["Low"] = "Low";
4391
+ TaskPriority["Medium"] = "Medium";
4392
+ TaskPriority["High"] = "High";
4393
+ TaskPriority["Critical"] = "Critical";
4394
+ })(TaskPriority || (TaskPriority = {}));
4395
+ var TaskStatus;
4396
+ (function (TaskStatus) {
4397
+ TaskStatus["Unassigned"] = "Unassigned";
4398
+ TaskStatus["Pending"] = "Pending";
4399
+ TaskStatus["Completed"] = "Completed";
4400
+ })(TaskStatus || (TaskStatus = {}));
4401
+ var TaskSlaCriteria;
4402
+ (function (TaskSlaCriteria) {
4403
+ TaskSlaCriteria["TaskCreated"] = "TaskCreated";
4404
+ TaskSlaCriteria["TaskAssigned"] = "TaskAssigned";
4405
+ TaskSlaCriteria["TaskCompleted"] = "TaskCompleted";
4406
+ })(TaskSlaCriteria || (TaskSlaCriteria = {}));
4407
+ var TaskSlaStatus;
4408
+ (function (TaskSlaStatus) {
4409
+ TaskSlaStatus["OverdueLater"] = "OverdueLater";
4410
+ TaskSlaStatus["OverdueSoon"] = "OverdueSoon";
4411
+ TaskSlaStatus["Overdue"] = "Overdue";
4412
+ TaskSlaStatus["CompletedInTime"] = "CompletedInTime";
4413
+ })(TaskSlaStatus || (TaskSlaStatus = {}));
4414
+ var TaskSourceName;
4415
+ (function (TaskSourceName) {
4416
+ TaskSourceName["Agent"] = "Agent";
4417
+ TaskSourceName["Workflow"] = "Workflow";
4418
+ TaskSourceName["Maestro"] = "Maestro";
4419
+ TaskSourceName["Default"] = "Default";
4420
+ })(TaskSourceName || (TaskSourceName = {}));
4421
+ /**
4422
+ * Task activity types
4423
+ */
4424
+ var TaskActivityType;
4425
+ (function (TaskActivityType) {
4426
+ TaskActivityType["Created"] = "Created";
4427
+ TaskActivityType["Assigned"] = "Assigned";
4428
+ TaskActivityType["Reassigned"] = "Reassigned";
4429
+ TaskActivityType["Unassigned"] = "Unassigned";
4430
+ TaskActivityType["Saved"] = "Saved";
4431
+ TaskActivityType["Forwarded"] = "Forwarded";
4432
+ TaskActivityType["Completed"] = "Completed";
4433
+ TaskActivityType["Commented"] = "Commented";
4434
+ TaskActivityType["Deleted"] = "Deleted";
4435
+ TaskActivityType["BulkSaved"] = "BulkSaved";
4436
+ TaskActivityType["BulkCompleted"] = "BulkCompleted";
4437
+ TaskActivityType["FirstOpened"] = "FirstOpened";
4438
+ })(TaskActivityType || (TaskActivityType = {}));
4439
+
4440
+ /**
4441
+ * Base path constants for different services
4442
+ */
4443
+ const ORCHESTRATOR_BASE = 'orchestrator_';
4444
+ const IDENTITY_BASE = 'identity_';
4445
+
4446
+ /**
4447
+ * Orchestrator Service Endpoints
4448
+ */
4449
+ /**
4450
+ * Task Service (Action Center) Endpoints
4451
+ */
4452
+ const TASK_ENDPOINTS = {
4453
+ GET_TASK_FORM_BY_ID: `${ORCHESTRATOR_BASE}/forms/TaskForms/GetTaskFormById`,
4454
+ GET_GENERIC_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/GenericTasks/GetTaskDataById`,
4455
+ GET_APP_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/AppTasks/GetAppTaskById`,
4456
+ };
4457
+
4458
+ /**
4459
+ * Identity/Authentication Endpoints
4460
+ */
4461
+ /**
4462
+ * Identity Service Endpoints
4463
+ */
4464
+ const IDENTITY_ENDPOINTS = {
4465
+ TOKEN: `${IDENTITY_BASE}/connect/token`,
4466
+ AUTHORIZE: `${IDENTITY_BASE}/connect/authorize`,
4467
+ };
4468
+
4469
+ ({
4470
+ [TaskType.Form]: TASK_ENDPOINTS.GET_TASK_FORM_BY_ID,
4471
+ [TaskType.App]: TASK_ENDPOINTS.GET_APP_TASK_BY_ID,
4472
+ [TaskType.DocumentValidation]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4473
+ [TaskType.DocumentClassification]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4474
+ [TaskType.External]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4475
+ [TaskType.DataLabeling]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4476
+ });
4369
4477
  var ActionCenterEventNames;
4370
4478
  (function (ActionCenterEventNames) {
4371
4479
  ActionCenterEventNames["TOKENREFRESHED"] = "AC.tokenRefreshed";
@@ -4743,22 +4851,6 @@ class TokenManager {
4743
4851
  }
4744
4852
  }
4745
4853
 
4746
- /**
4747
- * Base path constants for different services
4748
- */
4749
- const IDENTITY_BASE = 'identity_';
4750
-
4751
- /**
4752
- * Identity/Authentication Endpoints
4753
- */
4754
- /**
4755
- * Identity Service Endpoints
4756
- */
4757
- const IDENTITY_ENDPOINTS = {
4758
- TOKEN: `${IDENTITY_BASE}/connect/token`,
4759
- AUTHORIZE: `${IDENTITY_BASE}/connect/authorize`,
4760
- };
4761
-
4762
4854
  class AuthService {
4763
4855
  constructor(config, executionContext) {
4764
4856
  // Only use stored OAuth context when completing an active callback (URL has ?code=).
@@ -5186,7 +5278,7 @@ function normalizeBaseUrl(url) {
5186
5278
  // Connection string placeholder that will be replaced during build
5187
5279
  const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
5188
5280
  // SDK Version placeholder
5189
- const SDK_VERSION = "1.2.1";
5281
+ const SDK_VERSION = "1.3.0";
5190
5282
  const VERSION = "Version";
5191
5283
  const SERVICE = "Service";
5192
5284
  const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -519,7 +519,7 @@ declare const telemetryClient: TelemetryClient;
519
519
  * SDK Telemetry constants
520
520
  */
521
521
  declare const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
522
- declare const SDK_VERSION = "1.2.1";
522
+ declare const SDK_VERSION = "1.3.0";
523
523
  declare const VERSION = "Version";
524
524
  declare const SERVICE = "Service";
525
525
  declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -4364,6 +4364,114 @@ function getErrorDetails(error) {
4364
4364
  };
4365
4365
  }
4366
4366
 
4367
+ /**
4368
+ * Types of tasks available in Action Center.
4369
+ * Each type determines the task's behavior, UI rendering, and completion requirements.
4370
+ */
4371
+ var TaskType;
4372
+ (function (TaskType) {
4373
+ /** A form-based task that renders a UiPath form layout for user input */
4374
+ TaskType["Form"] = "FormTask";
4375
+ /** An externally managed task handled outside of Action Center */
4376
+ TaskType["External"] = "ExternalTask";
4377
+ /** A task powered by a UiPath App */
4378
+ TaskType["App"] = "AppTask";
4379
+ /** A document validation task for reviewing and correcting extracted document data */
4380
+ TaskType["DocumentValidation"] = "DocumentValidationTask";
4381
+ /** A document classification task for categorizing documents */
4382
+ TaskType["DocumentClassification"] = "DocumentClassificationTask";
4383
+ /** A data labeling task for annotating training data */
4384
+ TaskType["DataLabeling"] = "DataLabelingTask";
4385
+ })(TaskType || (TaskType = {}));
4386
+ var TaskPriority;
4387
+ (function (TaskPriority) {
4388
+ TaskPriority["Low"] = "Low";
4389
+ TaskPriority["Medium"] = "Medium";
4390
+ TaskPriority["High"] = "High";
4391
+ TaskPriority["Critical"] = "Critical";
4392
+ })(TaskPriority || (TaskPriority = {}));
4393
+ var TaskStatus;
4394
+ (function (TaskStatus) {
4395
+ TaskStatus["Unassigned"] = "Unassigned";
4396
+ TaskStatus["Pending"] = "Pending";
4397
+ TaskStatus["Completed"] = "Completed";
4398
+ })(TaskStatus || (TaskStatus = {}));
4399
+ var TaskSlaCriteria;
4400
+ (function (TaskSlaCriteria) {
4401
+ TaskSlaCriteria["TaskCreated"] = "TaskCreated";
4402
+ TaskSlaCriteria["TaskAssigned"] = "TaskAssigned";
4403
+ TaskSlaCriteria["TaskCompleted"] = "TaskCompleted";
4404
+ })(TaskSlaCriteria || (TaskSlaCriteria = {}));
4405
+ var TaskSlaStatus;
4406
+ (function (TaskSlaStatus) {
4407
+ TaskSlaStatus["OverdueLater"] = "OverdueLater";
4408
+ TaskSlaStatus["OverdueSoon"] = "OverdueSoon";
4409
+ TaskSlaStatus["Overdue"] = "Overdue";
4410
+ TaskSlaStatus["CompletedInTime"] = "CompletedInTime";
4411
+ })(TaskSlaStatus || (TaskSlaStatus = {}));
4412
+ var TaskSourceName;
4413
+ (function (TaskSourceName) {
4414
+ TaskSourceName["Agent"] = "Agent";
4415
+ TaskSourceName["Workflow"] = "Workflow";
4416
+ TaskSourceName["Maestro"] = "Maestro";
4417
+ TaskSourceName["Default"] = "Default";
4418
+ })(TaskSourceName || (TaskSourceName = {}));
4419
+ /**
4420
+ * Task activity types
4421
+ */
4422
+ var TaskActivityType;
4423
+ (function (TaskActivityType) {
4424
+ TaskActivityType["Created"] = "Created";
4425
+ TaskActivityType["Assigned"] = "Assigned";
4426
+ TaskActivityType["Reassigned"] = "Reassigned";
4427
+ TaskActivityType["Unassigned"] = "Unassigned";
4428
+ TaskActivityType["Saved"] = "Saved";
4429
+ TaskActivityType["Forwarded"] = "Forwarded";
4430
+ TaskActivityType["Completed"] = "Completed";
4431
+ TaskActivityType["Commented"] = "Commented";
4432
+ TaskActivityType["Deleted"] = "Deleted";
4433
+ TaskActivityType["BulkSaved"] = "BulkSaved";
4434
+ TaskActivityType["BulkCompleted"] = "BulkCompleted";
4435
+ TaskActivityType["FirstOpened"] = "FirstOpened";
4436
+ })(TaskActivityType || (TaskActivityType = {}));
4437
+
4438
+ /**
4439
+ * Base path constants for different services
4440
+ */
4441
+ const ORCHESTRATOR_BASE = 'orchestrator_';
4442
+ const IDENTITY_BASE = 'identity_';
4443
+
4444
+ /**
4445
+ * Orchestrator Service Endpoints
4446
+ */
4447
+ /**
4448
+ * Task Service (Action Center) Endpoints
4449
+ */
4450
+ const TASK_ENDPOINTS = {
4451
+ GET_TASK_FORM_BY_ID: `${ORCHESTRATOR_BASE}/forms/TaskForms/GetTaskFormById`,
4452
+ GET_GENERIC_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/GenericTasks/GetTaskDataById`,
4453
+ GET_APP_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/AppTasks/GetAppTaskById`,
4454
+ };
4455
+
4456
+ /**
4457
+ * Identity/Authentication Endpoints
4458
+ */
4459
+ /**
4460
+ * Identity Service Endpoints
4461
+ */
4462
+ const IDENTITY_ENDPOINTS = {
4463
+ TOKEN: `${IDENTITY_BASE}/connect/token`,
4464
+ AUTHORIZE: `${IDENTITY_BASE}/connect/authorize`,
4465
+ };
4466
+
4467
+ ({
4468
+ [TaskType.Form]: TASK_ENDPOINTS.GET_TASK_FORM_BY_ID,
4469
+ [TaskType.App]: TASK_ENDPOINTS.GET_APP_TASK_BY_ID,
4470
+ [TaskType.DocumentValidation]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4471
+ [TaskType.DocumentClassification]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4472
+ [TaskType.External]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4473
+ [TaskType.DataLabeling]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
4474
+ });
4367
4475
  var ActionCenterEventNames;
4368
4476
  (function (ActionCenterEventNames) {
4369
4477
  ActionCenterEventNames["TOKENREFRESHED"] = "AC.tokenRefreshed";
@@ -4741,22 +4849,6 @@ class TokenManager {
4741
4849
  }
4742
4850
  }
4743
4851
 
4744
- /**
4745
- * Base path constants for different services
4746
- */
4747
- const IDENTITY_BASE = 'identity_';
4748
-
4749
- /**
4750
- * Identity/Authentication Endpoints
4751
- */
4752
- /**
4753
- * Identity Service Endpoints
4754
- */
4755
- const IDENTITY_ENDPOINTS = {
4756
- TOKEN: `${IDENTITY_BASE}/connect/token`,
4757
- AUTHORIZE: `${IDENTITY_BASE}/connect/authorize`,
4758
- };
4759
-
4760
4852
  class AuthService {
4761
4853
  constructor(config, executionContext) {
4762
4854
  // Only use stored OAuth context when completing an active callback (URL has ?code=).
@@ -5184,7 +5276,7 @@ function normalizeBaseUrl(url) {
5184
5276
  // Connection string placeholder that will be replaced during build
5185
5277
  const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
5186
5278
  // SDK Version placeholder
5187
- const SDK_VERSION = "1.2.1";
5279
+ const SDK_VERSION = "1.3.0";
5188
5280
  const VERSION = "Version";
5189
5281
  const SERVICE = "Service";
5190
5282
  const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -1903,7 +1903,7 @@ const EntityFieldTypeMap = {
1903
1903
  // Connection string placeholder that will be replaced during build
1904
1904
  const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
1905
1905
  // SDK Version placeholder
1906
- const SDK_VERSION = "1.2.1";
1906
+ const SDK_VERSION = "1.3.0";
1907
1907
  const VERSION = "Version";
1908
1908
  const SERVICE = "Service";
1909
1909
  const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -2286,11 +2286,7 @@ class EntityService extends BaseService {
2286
2286
  expansionLevel: options.expansionLevel
2287
2287
  });
2288
2288
  const response = await this.get(DATA_FABRIC_ENDPOINTS.ENTITY.GET_RECORD_BY_ID(entityId, recordId), { params });
2289
- // Convert PascalCase response to camelCase
2290
- const camelResponse = pascalToCamelCaseKeys(response.data);
2291
- // Apply EntityMap transformations
2292
- const transformedResponse = transformData(camelResponse, EntityMap);
2293
- return transformedResponse;
2289
+ return response.data;
2294
2290
  }
2295
2291
  /**
2296
2292
  * Inserts a single record into an entity by entity ID
@@ -2323,9 +2319,7 @@ class EntityService extends BaseService {
2323
2319
  params,
2324
2320
  ...options
2325
2321
  });
2326
- // Convert PascalCase response to camelCase
2327
- const camelResponse = pascalToCamelCaseKeys(response.data);
2328
- return camelResponse;
2322
+ return response.data;
2329
2323
  }
2330
2324
  /**
2331
2325
  * Inserts data into an entity by entity ID using batch insert
@@ -2366,9 +2360,7 @@ class EntityService extends BaseService {
2366
2360
  params,
2367
2361
  ...options
2368
2362
  });
2369
- // Convert PascalCase response to camelCase
2370
- const camelResponse = pascalToCamelCaseKeys(response.data);
2371
- return camelResponse;
2363
+ return response.data;
2372
2364
  }
2373
2365
  /**
2374
2366
  * Updates a single record in an entity by entity ID
@@ -2402,9 +2394,7 @@ class EntityService extends BaseService {
2402
2394
  params,
2403
2395
  ...options
2404
2396
  });
2405
- // Convert PascalCase response to camelCase
2406
- const camelResponse = pascalToCamelCaseKeys(response.data);
2407
- return camelResponse;
2397
+ return response.data;
2408
2398
  }
2409
2399
  /**
2410
2400
  * Updates data in an entity by entity ID
@@ -2446,9 +2436,7 @@ class EntityService extends BaseService {
2446
2436
  params,
2447
2437
  ...options
2448
2438
  });
2449
- // Convert PascalCase response to camelCase
2450
- const camelResponse = pascalToCamelCaseKeys(response.data);
2451
- return camelResponse;
2439
+ return response.data;
2452
2440
  }
2453
2441
  /**
2454
2442
  * Deletes data from an entity by entity ID
@@ -2478,9 +2466,7 @@ class EntityService extends BaseService {
2478
2466
  params,
2479
2467
  ...options
2480
2468
  });
2481
- // Convert PascalCase response to camelCase
2482
- const camelResponse = pascalToCamelCaseKeys(response.data);
2483
- return camelResponse;
2469
+ return response.data;
2484
2470
  }
2485
2471
  /**
2486
2472
  * Gets all entities in the system
@@ -2532,7 +2518,7 @@ class EntityService extends BaseService {
2532
2518
  *
2533
2519
  * // Get the recordId from getAllRecords()
2534
2520
  * const records = await entities.getAllRecords(entityId);
2535
- * const recordId = records[0].id;
2521
+ * const recordId = records[0].Id;
2536
2522
  *
2537
2523
  * // Download attachment for a specific record and field
2538
2524
  * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents');
@@ -2566,7 +2552,7 @@ class EntityService extends BaseService {
2566
2552
  *
2567
2553
  * // Get the recordId from getAllRecords()
2568
2554
  * const records = await entities.getAllRecords(entityId);
2569
- * const recordId = records[0].id;
2555
+ * const recordId = records[0].Id;
2570
2556
  *
2571
2557
  * // Upload a file attachment
2572
2558
  * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
@@ -2582,9 +2568,7 @@ class EntityService extends BaseService {
2582
2568
  }
2583
2569
  const params = createParams({ expansionLevel: options?.expansionLevel });
2584
2570
  const response = await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPLOAD_ATTACHMENT(entityId, recordId, fieldName), formData, { params });
2585
- // Convert PascalCase response to camelCase
2586
- const camelResponse = pascalToCamelCaseKeys(response.data);
2587
- return camelResponse;
2571
+ return response.data;
2588
2572
  }
2589
2573
  /**
2590
2574
  * Removes an attachment from a File-type field of an entity record
@@ -2606,7 +2590,7 @@ class EntityService extends BaseService {
2606
2590
  *
2607
2591
  * // Get the recordId from getAllRecords()
2608
2592
  * const records = await entities.getAllRecords(entityId);
2609
- * const recordId = records[0].id;
2593
+ * const recordId = records[0].Id;
2610
2594
  *
2611
2595
  * // Delete attachment for a specific record and field
2612
2596
  * await entities.deleteAttachment(entityId, recordId, 'Documents');
@@ -313,7 +313,7 @@ interface EntityRecord {
313
313
  /**
314
314
  * Unique identifier for the record
315
315
  */
316
- id: string;
316
+ Id: string;
317
317
  /**
318
318
  * Additional dynamic fields for the entity
319
319
  */
@@ -358,29 +358,35 @@ interface EntityInsertOptions {
358
358
  /**
359
359
  * Options for inserting a single record into an entity
360
360
  */
361
- type EntityInsertRecordOptions = EntityInsertOptions;
361
+ interface EntityInsertRecordOptions extends EntityInsertOptions {
362
+ }
362
363
  /**
363
364
  * Options for batch inserting data into an entity
364
365
  * @deprecated Use {@link EntityInsertRecordsOptions} instead for better clarity on inserting multiple records into an entity. This type will be removed in future versions.
365
366
  */
366
- type EntityBatchInsertOptions = EntityOperationOptions;
367
+ interface EntityBatchInsertOptions extends EntityOperationOptions {
368
+ }
367
369
  /**
368
370
  * Options for inserting multiple records into an entity
369
371
  */
370
- type EntityInsertRecordsOptions = EntityOperationOptions;
372
+ interface EntityInsertRecordsOptions extends EntityOperationOptions {
373
+ }
371
374
  /**
372
375
  * Options for updating a single record in an entity
373
376
  */
374
- type EntityUpdateRecordOptions = EntityGetRecordByIdOptions;
377
+ interface EntityUpdateRecordOptions extends EntityGetRecordByIdOptions {
378
+ }
375
379
  /**
376
380
  * Options for updating data in an entity
377
381
  * @deprecated Use {@link EntityUpdateRecordsOptions} instead for better clarity on updating records in an entity. This type will be removed in future versions.
378
382
  */
379
- type EntityUpdateOptions = EntityOperationOptions;
383
+ interface EntityUpdateOptions extends EntityOperationOptions {
384
+ }
380
385
  /**
381
386
  * Options for updating data in an entity
382
387
  */
383
- type EntityUpdateRecordsOptions = EntityOperationOptions;
388
+ interface EntityUpdateRecordsOptions extends EntityOperationOptions {
389
+ }
384
390
  /**
385
391
  * Options for deleting data from an entity
386
392
  * @deprecated Use {@link EntityDeleteRecordsOptions} instead for better clarity on deleting records from an entity. This type will be removed in future versions.
@@ -392,7 +398,8 @@ interface EntityDeleteOptions {
392
398
  /**
393
399
  * Options for deleting records in an entity
394
400
  */
395
- type EntityDeleteRecordsOptions = EntityDeleteOptions;
401
+ interface EntityDeleteRecordsOptions extends EntityDeleteOptions {
402
+ }
396
403
  /**
397
404
  * Supported file types for attachment upload
398
405
  */
@@ -431,27 +438,32 @@ interface EntityOperationResponse {
431
438
  failureRecords: FailureRecord[];
432
439
  }
433
440
  /**
434
- * Response from inserting a single record into an entity
435
- * Returns the inserted record with its generated record ID and other fields
441
+ * Response from inserting a single record into an entity.
442
+ * Returns the inserted record with its generated record ID and other fields.
436
443
  */
437
- type EntityInsertResponse = EntityRecord;
444
+ interface EntityInsertResponse extends EntityRecord {
445
+ }
438
446
  /**
439
- * Response from updating a single record in an entity
440
- * Returns the updated record
447
+ * Response from updating a single record in an entity.
448
+ * Returns the updated record.
441
449
  */
442
- type EntityUpdateRecordResponse = EntityRecord;
450
+ interface EntityUpdateRecordResponse extends EntityRecord {
451
+ }
443
452
  /**
444
453
  * Response from batch inserting data into an entity
445
454
  */
446
- type EntityBatchInsertResponse = EntityOperationResponse;
455
+ interface EntityBatchInsertResponse extends EntityOperationResponse {
456
+ }
447
457
  /**
448
458
  * Response from updating data in an entity
449
459
  */
450
- type EntityUpdateResponse = EntityOperationResponse;
460
+ interface EntityUpdateResponse extends EntityOperationResponse {
461
+ }
451
462
  /**
452
463
  * Response from deleting data from an entity
453
464
  */
454
- type EntityDeleteResponse = EntityOperationResponse;
465
+ interface EntityDeleteResponse extends EntityOperationResponse {
466
+ }
455
467
  /**
456
468
  * Entity type enum
457
469
  */
@@ -762,7 +774,7 @@ interface EntityServiceModel {
762
774
  * // First, get records to obtain the record ID
763
775
  * const records = await entities.getAllRecords(<entityId>);
764
776
  * // Get the recordId for the record
765
- * const recordId = records.items[0].id;
777
+ * const recordId = records.items[0].Id;
766
778
  * // Get the record
767
779
  * const record = await entities.getRecordById(<entityId>, recordId);
768
780
  *
@@ -866,7 +878,7 @@ interface EntityServiceModel {
866
878
  * Note: Records updated using updateRecordsById will not trigger Data Fabric trigger events. Use {@link updateRecordById} if you need trigger events to fire for each updated record.
867
879
  *
868
880
  * @param id - UUID of the entity
869
- * @param data - Array of records to update. Each record MUST contain the record Id.
881
+ * @param data - Array of records to update. Each record MUST contain the record id.
870
882
  * @param options - Update options
871
883
  * @returns Promise resolving to update response
872
884
  * {@link EntityUpdateResponse}
@@ -932,7 +944,7 @@ interface EntityServiceModel {
932
944
  * // First, get records to obtain the record ID
933
945
  * const records = await entities.getAllRecords("<entityId>");
934
946
  * // Get the recordId for the record that contains the attachment
935
- * const recordId = records.items[0].id;
947
+ * const recordId = records.items[0].Id;
936
948
  *
937
949
  * // Get the entityId from getAll()
938
950
  * const allEntities = await entities.getAll();
@@ -940,7 +952,7 @@ interface EntityServiceModel {
940
952
  *
941
953
  * // Get the recordId from getAllRecords()
942
954
  * const records = await entities.getAllRecords(entityId);
943
- * const recordId = records[0].id;
955
+ * const recordId = records[0].Id;
944
956
  *
945
957
  * // Download attachment using service method
946
958
  * const response = await entities.downloadAttachment(entityId, recordId, 'Documents');
@@ -992,7 +1004,7 @@ interface EntityServiceModel {
992
1004
  *
993
1005
  * // Get the recordId from getAllRecords()
994
1006
  * const records = await entities.getAllRecords(entityId);
995
- * const recordId = records[0].id;
1007
+ * const recordId = records[0].Id;
996
1008
  *
997
1009
  * // Browser: Upload a file from an input element
998
1010
  * const fileInput = document.getElementById('file-input') as HTMLInputElement;
@@ -1025,7 +1037,7 @@ interface EntityServiceModel {
1025
1037
  *
1026
1038
  * // Get the recordId from getAllRecords()
1027
1039
  * const records = await entities.getAllRecords(entityId);
1028
- * const recordId = records[0].id;
1040
+ * const recordId = records[0].Id;
1029
1041
  *
1030
1042
  * // Delete attachment for a specific record and field
1031
1043
  * await entities.deleteAttachment(entityId, recordId, 'Documents');
@@ -1433,7 +1445,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1433
1445
  *
1434
1446
  * // Get the recordId from getAllRecords()
1435
1447
  * const records = await entities.getAllRecords(entityId);
1436
- * const recordId = records[0].id;
1448
+ * const recordId = records[0].Id;
1437
1449
  *
1438
1450
  * // Download attachment for a specific record and field
1439
1451
  * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents');
@@ -1462,7 +1474,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1462
1474
  *
1463
1475
  * // Get the recordId from getAllRecords()
1464
1476
  * const records = await entities.getAllRecords(entityId);
1465
- * const recordId = records[0].id;
1477
+ * const recordId = records[0].Id;
1466
1478
  *
1467
1479
  * // Upload a file attachment
1468
1480
  * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
@@ -1489,7 +1501,7 @@ declare class EntityService extends BaseService implements EntityServiceModel {
1489
1501
  *
1490
1502
  * // Get the recordId from getAllRecords()
1491
1503
  * const records = await entities.getAllRecords(entityId);
1492
- * const recordId = records[0].id;
1504
+ * const recordId = records[0].Id;
1493
1505
  *
1494
1506
  * // Delete attachment for a specific record and field
1495
1507
  * await entities.deleteAttachment(entityId, recordId, 'Documents');