@uipath/uipath-typescript 1.3.6 → 1.3.8

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 (44) hide show
  1. package/dist/assets/index.cjs +243 -6
  2. package/dist/assets/index.d.ts +113 -13
  3. package/dist/assets/index.mjs +243 -6
  4. package/dist/attachments/index.cjs +42 -6
  5. package/dist/attachments/index.d.ts +8 -0
  6. package/dist/attachments/index.mjs +42 -6
  7. package/dist/buckets/index.cjs +211 -6
  8. package/dist/buckets/index.d.ts +57 -12
  9. package/dist/buckets/index.mjs +211 -6
  10. package/dist/cases/index.cjs +180 -6
  11. package/dist/cases/index.d.ts +165 -3
  12. package/dist/cases/index.mjs +181 -7
  13. package/dist/conversational-agent/index.cjs +235 -85
  14. package/dist/conversational-agent/index.d.ts +327 -80
  15. package/dist/conversational-agent/index.mjs +234 -84
  16. package/dist/core/index.cjs +18 -6
  17. package/dist/core/index.d.ts +1 -1
  18. package/dist/core/index.mjs +18 -6
  19. package/dist/entities/index.cjs +74 -10
  20. package/dist/entities/index.d.ts +102 -11
  21. package/dist/entities/index.mjs +75 -11
  22. package/dist/feedback/index.cjs +293 -10
  23. package/dist/feedback/index.d.ts +425 -12
  24. package/dist/feedback/index.mjs +293 -10
  25. package/dist/index.cjs +463 -17
  26. package/dist/index.d.ts +885 -39
  27. package/dist/index.mjs +464 -18
  28. package/dist/index.umd.js +463 -17
  29. package/dist/jobs/index.cjs +211 -6
  30. package/dist/jobs/index.d.ts +68 -23
  31. package/dist/jobs/index.mjs +211 -6
  32. package/dist/maestro-processes/index.cjs +79 -6
  33. package/dist/maestro-processes/index.d.ts +8 -0
  34. package/dist/maestro-processes/index.mjs +79 -6
  35. package/dist/processes/index.cjs +279 -7
  36. package/dist/processes/index.d.ts +125 -2
  37. package/dist/processes/index.mjs +279 -7
  38. package/dist/queues/index.cjs +211 -6
  39. package/dist/queues/index.d.ts +57 -12
  40. package/dist/queues/index.mjs +211 -6
  41. package/dist/tasks/index.cjs +42 -6
  42. package/dist/tasks/index.d.ts +8 -0
  43. package/dist/tasks/index.mjs +42 -6
  44. package/package.json +1 -1
@@ -109,6 +109,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
109
109
  offsetParam?: string;
110
110
  tokenParam?: string;
111
111
  countParam?: string;
112
+ convertToSkip?: boolean;
112
113
  };
113
114
  };
114
115
  }
@@ -221,6 +222,13 @@ interface ApiResponse<T> {
221
222
  */
222
223
  declare class BaseService {
223
224
  #private;
225
+ /**
226
+ * SDK configuration (read-only). Available to subclasses so they can
227
+ * fall back to init-time defaults like `folderKey`.
228
+ */
229
+ protected readonly config: {
230
+ folderKey?: string;
231
+ };
224
232
  /**
225
233
  * Creates a base service instance with dependency injection.
226
234
  *
@@ -1163,7 +1171,34 @@ interface ToolCallStartEvent {
1163
1171
  * Optional metadata pertaining to the tool call.
1164
1172
  */
1165
1173
  metaData?: MetaData;
1174
+ /**
1175
+ * Indicates that the tool call requires user confirmation before execution.
1176
+ * When true, the client should render a confirmation UI and respond with a
1177
+ * `confirmToolCall` event on the same tool call.
1178
+ */
1179
+ requireConfirmation?: boolean;
1180
+ /**
1181
+ * JSON schema describing the tool's input parameters. Present when
1182
+ * `requireConfirmation` is true so the client can render an editable form.
1183
+ */
1184
+ inputSchema?: JSONValue;
1166
1185
  }
1186
+ /**
1187
+ * Sent by the client to approve or reject a tool call that was emitted with
1188
+ * `requireConfirmation: true`. Carries the user's decision and, when approved,
1189
+ * the (possibly edited) input the tool should execute with.
1190
+ *
1191
+ * `input` is required when `approved` is `true` and optional when `approved`
1192
+ * is `false`. The discriminated union enforces this at compile time so
1193
+ * `{ approved: true }` (no `input`) is a type error.
1194
+ */
1195
+ type ToolCallConfirmationEvent = {
1196
+ approved: true;
1197
+ input: JSONValue;
1198
+ } | {
1199
+ approved: false;
1200
+ input?: JSONValue;
1201
+ };
1167
1202
  /**
1168
1203
  * Signals the end of a tool call.
1169
1204
  */
@@ -1224,6 +1259,11 @@ interface ToolCallEvent {
1224
1259
  * Signals the end of a tool call.
1225
1260
  */
1226
1261
  endToolCall?: ToolCallEndEvent;
1262
+ /**
1263
+ * Signals the user's approve/reject decision for a tool call that was
1264
+ * emitted with `requireConfirmation: true`.
1265
+ */
1266
+ confirmToolCall?: ToolCallConfirmationEvent;
1227
1267
  /**
1228
1268
  * Allows additional events to be sent in the context of the enclosing event stream.
1229
1269
  */
@@ -1235,6 +1275,11 @@ interface ToolCallEvent {
1235
1275
  }
1236
1276
  /**
1237
1277
  * Schema for tool call confirmation interrupt value.
1278
+ *
1279
+ * @deprecated Tool call confirmation now travels on {@link ToolCallStartEvent} via
1280
+ * `requireConfirmation: true` / `inputSchema` and is responded to with
1281
+ * {@link ToolCallConfirmationEvent}. This shape is retained for agents on the legacy
1282
+ * runtime that still emit confirmations as interrupts.
1238
1283
  */
1239
1284
  interface ToolCallConfirmationValue {
1240
1285
  /**
@@ -1256,6 +1301,10 @@ interface ToolCallConfirmationValue {
1256
1301
  }
1257
1302
  /**
1258
1303
  * Schema for tool call confirmation end value.
1304
+ *
1305
+ * @deprecated Confirmation responses now use {@link ToolCallConfirmationEvent} (sent via
1306
+ * {@link ToolCallStream.sendToolCallConfirm}). This shape is retained for agents on the
1307
+ * legacy runtime that consume confirmations through the interrupt-end channel.
1259
1308
  */
1260
1309
  interface ToolCallConfirmationEndValue {
1261
1310
  /**
@@ -1269,6 +1318,11 @@ interface ToolCallConfirmationEndValue {
1269
1318
  }
1270
1319
  /**
1271
1320
  * Known interrupt start event for tool call confirmation.
1321
+ *
1322
+ * @deprecated Emitted only by agents on the legacy runtime. Agents on the current runtime
1323
+ * express confirmation as `requireConfirmation: true` on {@link ToolCallStartEvent}, with
1324
+ * the client responding via {@link ToolCallConfirmationEvent} (`confirmToolCall` on
1325
+ * {@link ToolCallEvent}).
1272
1326
  */
1273
1327
  interface ToolCallConfirmationInterruptStartEvent {
1274
1328
  /**
@@ -1858,6 +1912,36 @@ type CompletedToolCall = ToolCallStartEvent & ToolCallEndEvent & {
1858
1912
  * });
1859
1913
  * });
1860
1914
  * ```
1915
+ *
1916
+ * @example Migrating from legacy interrupt-based confirmation
1917
+ * ```typescript
1918
+ * // BEFORE — legacy interrupt flow
1919
+ * message.onInterruptStart(async ({ interruptId, startEvent }) => {
1920
+ * if (startEvent.type !== InterruptType.ToolCallConfirmation) return;
1921
+ * const { toolName, inputSchema, inputValue } = startEvent.value;
1922
+ *
1923
+ * const decision = await showConfirmationDialog({
1924
+ * toolName, inputSchema, input: inputValue,
1925
+ * });
1926
+ * message.sendInterruptEnd(interruptId, {
1927
+ * approved: decision.approved,
1928
+ * input: decision.editedInput,
1929
+ * });
1930
+ * });
1931
+ *
1932
+ * // AFTER — new tool-call confirmation flow
1933
+ * message.onToolCallStart(async (toolCall) => {
1934
+ * const { toolName, input, requireConfirmation, inputSchema } = toolCall.startEvent;
1935
+ * if (!requireConfirmation) return;
1936
+ *
1937
+ * const decision = await showConfirmationDialog({ toolName, inputSchema, input });
1938
+ * if (decision.approved) {
1939
+ * toolCall.sendToolCallConfirm({ approved: true, input: decision.editedInput });
1940
+ * } else {
1941
+ * toolCall.sendToolCallConfirm({ approved: false });
1942
+ * }
1943
+ * });
1944
+ * ```
1861
1945
  */
1862
1946
  interface ToolCallStream {
1863
1947
  /** Unique identifier for this tool call */
@@ -1912,6 +1996,23 @@ interface ToolCallStream {
1912
1996
  * ```
1913
1997
  */
1914
1998
  onToolCallEnd(cb: (endToolCall: ToolCallEndEvent) => void): () => void;
1999
+ /**
2000
+ * Registers a handler for tool call confirmation events. Fired when the
2001
+ * peer responds to a tool call that was emitted with
2002
+ * `requireConfirmation: true` on its start event.
2003
+ *
2004
+ * @param callback - Callback receiving the confirmation event
2005
+ * @returns Cleanup function to remove the handler
2006
+ *
2007
+ * @example Handling a confirmation response (agent-side)
2008
+ * ```typescript
2009
+ * toolCall.onToolCallConfirm(({ approved, input }) => {
2010
+ * if (approved) executeTool(toolCall.startEvent.toolName, input);
2011
+ * else cancelToolCall();
2012
+ * });
2013
+ * ```
2014
+ */
2015
+ onToolCallConfirm(callback: (confirmToolCall: ToolCallConfirmationEvent) => void): () => void;
1915
2016
  /**
1916
2017
  * Ends the tool call
1917
2018
  *
@@ -1925,6 +2026,25 @@ interface ToolCallStream {
1925
2026
  * ```
1926
2027
  */
1927
2028
  sendToolCallEnd(endToolCall?: ToolCallEndEvent): void;
2029
+ /**
2030
+ * Sends a tool call confirmation (approve or reject) for a tool call that
2031
+ * was emitted with `requireConfirmation: true`. Replaces the legacy
2032
+ * interrupt-based confirmation flow.
2033
+ *
2034
+ * @param confirmToolCall - The user's decision and (when approved) the
2035
+ * possibly-edited input the tool should execute with
2036
+ *
2037
+ * @example Approving a tool call
2038
+ * ```typescript
2039
+ * toolCall.sendToolCallConfirm({ approved: true, input: editedInput });
2040
+ * ```
2041
+ *
2042
+ * @example Rejecting a tool call
2043
+ * ```typescript
2044
+ * toolCall.sendToolCallConfirm({ approved: false });
2045
+ * ```
2046
+ */
2047
+ sendToolCallConfirm(confirmToolCall: ToolCallConfirmationEvent): void;
1928
2048
  /**
1929
2049
  * Sends an error start event for this tool call
1930
2050
  * @param args - Error details including optional error ID and message
@@ -2543,6 +2663,28 @@ interface MessageStream {
2543
2663
  * ```
2544
2664
  */
2545
2665
  sendInterruptEnd(interruptId: string, endInterrupt: InterruptEndEvent): void;
2666
+ /**
2667
+ * Registers a handler for tool-call confirmation events on this message
2668
+ *
2669
+ * Fired when a peer responds to a tool call that was emitted with
2670
+ * `requireConfirmation: true`. The handler runs at the message level, so it
2671
+ * fires even if no per-tool-call stream exists for the confirmed `toolCallId`.
2672
+ *
2673
+ * @param callback - Callback receiving the toolCallId and the confirmation event
2674
+ * @returns Cleanup function to remove the handler
2675
+ *
2676
+ * @example Handling a tool-call confirmation response
2677
+ * ```typescript
2678
+ * message.onToolCallConfirm(({ toolCallId, confirmEvent }) => {
2679
+ * if (confirmEvent.approved) executeTool(toolCallId, confirmEvent.input);
2680
+ * else cancelToolCall(toolCallId);
2681
+ * });
2682
+ * ```
2683
+ */
2684
+ onToolCallConfirm(callback: (args: {
2685
+ toolCallId: string;
2686
+ confirmEvent: ToolCallConfirmationEvent;
2687
+ }) => void): () => void;
2546
2688
  /**
2547
2689
  * Starts a new content part stream in this message
2548
2690
  *
@@ -4385,7 +4527,7 @@ declare const AgentMap: {
4385
4527
  };
4386
4528
 
4387
4529
  /**
4388
- * Types for User Service
4530
+ * Types for User Settings Service
4389
4531
  */
4390
4532
  /**
4391
4533
  * Response for getting user settings
@@ -4463,46 +4605,92 @@ interface UserSettingsUpdateOptions {
4463
4605
  }
4464
4606
 
4465
4607
  /**
4466
- * Service for managing UiPath User Settings
4608
+ * Service for reading and updating the current user's profile and context settings.
4467
4609
  *
4468
- * User settings are passed to the agent for all conversations
4469
- * to provide user context (name, email, role, timezone, etc.).
4610
+ * User settings are user-supplied profile fields (name, email, role, department, company,
4611
+ * country, timezone) that the SDK passes to a UiPath Conversational Agent on every conversation
4612
+ * so the agent can personalize its responses. Settings are scoped to the calling user — identified
4613
+ * by the access token for user tokens, or by the externalUserId option for app-scoped tokens.
4470
4614
  *
4471
- * @internal
4615
+ * Accessed via `conversationalAgent.user`.
4616
+ *
4617
+ * @example Read current settings
4618
+ * ```typescript
4619
+ * import { ConversationalAgent } from '@uipath/uipath-typescript/conversational-agent';
4620
+ *
4621
+ * const conversationalAgent = new ConversationalAgent(sdk);
4622
+ *
4623
+ * const settings = await conversationalAgent.user.getSettings();
4624
+ * console.log(settings.name, settings.email, settings.timezone);
4625
+ * ```
4626
+ *
4627
+ * @example Update specific fields (partial update)
4628
+ * ```typescript
4629
+ * await conversationalAgent.user.updateSettings({
4630
+ * name: 'John Doe',
4631
+ * timezone: 'America/New_York'
4632
+ * });
4633
+ * ```
4634
+ *
4635
+ * @example Clear a field by setting it to null
4636
+ * ```typescript
4637
+ * await conversationalAgent.user.updateSettings({
4638
+ * department: null
4639
+ * });
4640
+ * ```
4472
4641
  */
4473
- interface UserServiceModel {
4642
+ interface UserSettingsServiceModel {
4474
4643
  /**
4475
- * Gets the current user's profile and context settings
4644
+ * Gets the current user's profile and context settings.
4645
+ *
4646
+ * Returns the full user settings record — profile fields the agent uses for personalization
4647
+ * (name, email, role, department, company, country, timezone) plus identifiers and timestamps.
4648
+ * Fields the user has not set are returned as `null`.
4476
4649
  *
4477
- * @returns Promise resolving to user settings object
4650
+ * @returns Promise resolving to the current user's settings
4478
4651
  * {@link UserSettingsGetResponse}
4652
+ *
4479
4653
  * @example
4480
4654
  * ```typescript
4481
- * const userSettings = await userService.getSettings();
4482
- * console.log(userSettings.name);
4483
- * console.log(userSettings.email);
4655
+ * const settings = await conversationalAgent.user.getSettings();
4656
+ * console.log(settings.name); // e.g. 'John Doe' or null
4657
+ * console.log(settings.email); // e.g. 'john@example.com' or null
4658
+ * console.log(settings.timezone); // e.g. 'America/New_York' or null
4484
4659
  * ```
4485
4660
  */
4486
4661
  getSettings(): Promise<UserSettingsGetResponse>;
4487
4662
  /**
4488
- * Updates the current user's profile and context settings
4663
+ * Updates the current user's profile and context settings.
4489
4664
  *
4490
- * @param options - Fields to update
4491
- * @returns Promise resolving to updated user settings
4665
+ * Accepts a partial payload — only fields included in `options` are changed. Pass `null` to
4666
+ * explicitly clear a field. Omitting a field leaves it unchanged. Returns the full updated
4667
+ * settings record.
4668
+ *
4669
+ * @param options - Fields to update; omit fields to leave them unchanged, set to `null` to clear
4670
+ * @returns Promise resolving to the updated user settings
4492
4671
  * {@link UserSettingsUpdateResponse}
4493
- * @example
4672
+ *
4673
+ * @example Partial update
4494
4674
  * ```typescript
4495
- * const updatedUserSettings = await userService.updateSettings({
4675
+ * const updated = await conversationalAgent.user.updateSettings({
4496
4676
  * name: 'John Doe',
4497
4677
  * timezone: 'America/New_York'
4498
4678
  * });
4499
4679
  * ```
4680
+ *
4681
+ * @example Clear fields by setting to null
4682
+ * ```typescript
4683
+ * await conversationalAgent.user.updateSettings({
4684
+ * role: null,
4685
+ * department: null
4686
+ * });
4687
+ * ```
4500
4688
  */
4501
4689
  updateSettings(options: UserSettingsUpdateOptions): Promise<UserSettingsUpdateResponse>;
4502
4690
  }
4503
4691
 
4504
4692
  /**
4505
- * Constants for User Service
4693
+ * Constants for User Settings Service
4506
4694
  */
4507
4695
  /**
4508
4696
  * Maps fields for User Settings entities to ensure consistent SDK naming
@@ -4664,6 +4852,8 @@ interface ConversationalAgentServiceModel {
4664
4852
  onConnectionStatusChanged(handler: (status: ConnectionStatus, error: Error | null) => void): () => void;
4665
4853
  /** Service for creating and managing conversations. See {@link ConversationServiceModel}. */
4666
4854
  readonly conversations: ConversationServiceModel;
4855
+ /** Service for reading and updating the current user's profile/context settings. See {@link UserSettingsServiceModel}. */
4856
+ readonly user: UserSettingsServiceModel;
4667
4857
  /**
4668
4858
  * Gets feature flags for the current tenant
4669
4859
  *
@@ -4682,6 +4872,21 @@ interface ConversationalAgentOptions {
4682
4872
  * external app client; omit for standard UiPath user tokens.
4683
4873
  */
4684
4874
  externalUserId?: string;
4875
+ /**
4876
+ * Optional identifier used in UiPath logs to identify the implementing service
4877
+ * of requests. External consumers do not need to set it; the server logs
4878
+ * missing values as "unknown".
4879
+ *
4880
+ * @internal
4881
+ */
4882
+ surfaceName?: string;
4883
+ /**
4884
+ * Optional version of the implementing service of requests. Paired with
4885
+ * `surfaceName` for internal telemetry.
4886
+ *
4887
+ * @internal
4888
+ */
4889
+ surfaceVersion?: string;
4685
4890
  /** Log level for debugging */
4686
4891
  logLevel?: LogLevel;
4687
4892
  }
@@ -4913,6 +5118,7 @@ declare abstract class ToolCallEventHelper extends ConversationEventHelperBase<T
4913
5118
  */
4914
5119
  readonly startEventMaybe: ToolCallStartEvent | undefined;
4915
5120
  protected readonly _endHandlers: ToolCallEndHandler[];
5121
+ protected readonly _confirmHandlers: ToolCallConfirmationHandler[];
4916
5122
  constructor(message: MessageEventHelper, toolCallId: string,
4917
5123
  /**
4918
5124
  * ToolCallStartEvent used to initialize the ToolCallEventHelper. Will be undefined if some other sub-event was
@@ -4951,6 +5157,19 @@ declare abstract class ToolCallEventHelper extends ConversationEventHelperBase<T
4951
5157
  * @deprecated Use onToolCallEnd
4952
5158
  */
4953
5159
  onEndToolCall(cb: ToolCallEndHandler): void;
5160
+ /**
5161
+ * Registers a handler for tool call confirmation events. Fired when the
5162
+ * peer responds to a tool call that was emitted with `requireConfirmation`.
5163
+ * @returns Cleanup function to remove the handler.
5164
+ */
5165
+ onToolCallConfirm(callback: ToolCallConfirmationHandler): () => void;
5166
+ /**
5167
+ * Sends a tool call confirmation (approve/reject) for a tool call that was
5168
+ * emitted with `requireConfirmation: true`. Replaces the legacy
5169
+ * `sendInterruptEnd` flow for tool call confirmation.
5170
+ * @throws Error if tool call has already ended.
5171
+ */
5172
+ sendToolCallConfirm(confirmToolCall: ToolCallConfirmationEvent): void;
4954
5173
  /**
4955
5174
  * Sends an error start event for this tool call.
4956
5175
  */
@@ -4992,6 +5211,7 @@ declare abstract class MessageEventHelper extends ConversationEventHelperBase<Me
4992
5211
  protected readonly _toolCallMap: Map<string, ToolCallEventHelperImpl>;
4993
5212
  protected readonly _interruptStartHandlers: InterruptStartHandler[];
4994
5213
  protected readonly _interruptEndHandlers: InterruptEndHandler[];
5214
+ protected readonly _toolCallConfirmHandlers: ToolCallConfirmHandler[];
4995
5215
  constructor(exchange: ExchangeEventHelper, messageId: string,
4996
5216
  /**
4997
5217
  * MessageStartEvent used to initialize the MessageEventHelper. Will be undefined if some other sub-event was
@@ -5125,6 +5345,18 @@ declare abstract class MessageEventHelper extends ConversationEventHelperBase<Me
5125
5345
  * @returns Cleanup function to remove the handler.
5126
5346
  */
5127
5347
  onInterruptEnd(cb: InterruptEndHandler): () => void;
5348
+ /**
5349
+ * Registers a handler for tool-call confirmation events. Fired when a peer
5350
+ * responds to a tool call that was emitted with `requireConfirmation: true`.
5351
+ *
5352
+ * Fires at the message level before the event is delegated to the per-tool-call
5353
+ * helper, so this handler runs even when no `ToolCallEventHelper` exists for the
5354
+ * confirmed tool call (e.g. on the agent side after the originating helper has
5355
+ * been cleaned up, or on the client side if no `onToolCallStart` is registered).
5356
+ *
5357
+ * @returns Cleanup function to remove the handler.
5358
+ */
5359
+ onToolCallConfirm(callback: ToolCallConfirmHandler): () => void;
5128
5360
  /**
5129
5361
  * Sends an interrupt start event.
5130
5362
  */
@@ -5869,6 +6101,8 @@ type SessionStartHandlerAsync = (session: SessionEventHelper) => Promise<Session
5869
6101
  type ToolCallEndHandler = (endToolCall: ToolCallEndEvent) => void;
5870
6102
  type ToolCallStartHandler = (toolCall: ToolCallEventHelper) => void;
5871
6103
  type ToolCallStartHandlerAsync = (toolCall: ToolCallEventHelper) => Promise<ToolCallEndEvent | void>;
6104
+ type ToolCallConfirmationHandler = (confirmToolCall: ToolCallConfirmationEvent) => void;
6105
+ type ToolCallConfirmHandler = (args: ToolCallConfirmationHandlerArgs) => void;
5872
6106
  type ToolCallCompletedHandler = (completedToolCall: CompletedToolCall) => void;
5873
6107
  type ContentPartCompletedHandler = (completedContentPart: CompletedContentPart) => void;
5874
6108
  type MessageCompletedHandler = (completedMessage: CompletedMessage) => void;
@@ -5939,6 +6173,10 @@ type InterruptCompletedHandlerArgs = {
5939
6173
  startEvent: InterruptStartEvent;
5940
6174
  endEvent: InterruptEndEvent;
5941
6175
  };
6176
+ type ToolCallConfirmationHandlerArgs = {
6177
+ toolCallId: string;
6178
+ confirmEvent: ToolCallConfirmationEvent;
6179
+ };
5942
6180
  type ConversationEventErrorSource = ConversationEventHelperBase<any, any>;
5943
6181
  type SendMessageWithContentPartOptions = Simplify<MakeRequired<Omit<ContentPartChunkEvent, 'contentPartSequence'>, 'data'> & MessageStartEventOptions & MakeOptional<ContentPartStartEvent, 'mimeType'>>;
5944
6182
  type ConversationEventHelperManagerConfig = {
@@ -6573,6 +6811,74 @@ declare class MessageService extends BaseService implements MessageServiceModel
6573
6811
  getContentPartById(conversationId: string, exchangeId: string, messageId: string, contentPartId: string): Promise<ContentPartGetResponse>;
6574
6812
  }
6575
6813
 
6814
+ /**
6815
+ * UserSettingsService - Service for managing user profile and context settings
6816
+ */
6817
+
6818
+ /**
6819
+ * Service for reading and updating the current user's profile and context settings.
6820
+ *
6821
+ * User settings are user-supplied profile fields (name, email, role, department, company,
6822
+ * country, timezone) that the SDK passes to a UiPath Conversational Agent on every conversation
6823
+ * so the agent can personalize its responses.
6824
+ */
6825
+ declare class UserSettingsService extends BaseService implements UserSettingsServiceModel {
6826
+ /**
6827
+ * Creates an instance of the UserSettingsService.
6828
+ *
6829
+ * @param instance - UiPath SDK instance providing authentication and configuration
6830
+ * @param options - Optional configuration (e.g. externalUserId for external app auth)
6831
+ */
6832
+ constructor(instance: IUiPath$1, options?: ConversationalAgentOptions);
6833
+ /**
6834
+ * Gets the current user's profile and context settings.
6835
+ *
6836
+ * Returns the full user settings record — profile fields the agent uses for personalization
6837
+ * (name, email, role, department, company, country, timezone) plus identifiers and timestamps.
6838
+ * Fields the user has not set are returned as `null`.
6839
+ *
6840
+ * @returns Promise resolving to the current user's settings
6841
+ * {@link UserSettingsGetResponse}
6842
+ *
6843
+ * @example
6844
+ * ```typescript
6845
+ * const settings = await conversationalAgent.user.getSettings();
6846
+ * console.log(settings.name); // e.g. 'John Doe' or null
6847
+ * console.log(settings.email); // e.g. 'john@example.com' or null
6848
+ * console.log(settings.timezone); // e.g. 'America/New_York' or null
6849
+ * ```
6850
+ */
6851
+ getSettings(): Promise<UserSettingsGetResponse>;
6852
+ /**
6853
+ * Updates the current user's profile and context settings.
6854
+ *
6855
+ * Accepts a partial payload — only fields included in `options` are changed. Pass `null` to
6856
+ * explicitly clear a field. Omitting a field leaves it unchanged. Returns the full updated
6857
+ * settings record.
6858
+ *
6859
+ * @param options - Fields to update; omit fields to leave them unchanged, set to `null` to clear
6860
+ * @returns Promise resolving to the updated user settings
6861
+ * {@link UserSettingsUpdateResponse}
6862
+ *
6863
+ * @example Partial update
6864
+ * ```typescript
6865
+ * const updated = await conversationalAgent.user.updateSettings({
6866
+ * name: 'John Doe',
6867
+ * timezone: 'America/New_York'
6868
+ * });
6869
+ * ```
6870
+ *
6871
+ * @example Clear fields by setting to null
6872
+ * ```typescript
6873
+ * await conversationalAgent.user.updateSettings({
6874
+ * role: null,
6875
+ * department: null
6876
+ * });
6877
+ * ```
6878
+ */
6879
+ updateSettings(options: UserSettingsUpdateOptions): Promise<UserSettingsUpdateResponse>;
6880
+ }
6881
+
6576
6882
  /**
6577
6883
  * ConversationalAgentService - Main entry point for Conversational Agent functionality
6578
6884
  */
@@ -6583,6 +6889,8 @@ declare class MessageService extends BaseService implements MessageServiceModel
6583
6889
  declare class ConversationalAgentService extends BaseService implements ConversationalAgentServiceModel {
6584
6890
  /** Service for creating and managing conversations. See {@link ConversationServiceModel}. */
6585
6891
  readonly conversations: ConversationService;
6892
+ /** Service for reading and updating the current user's profile/context settings. See {@link UserSettingsServiceModel}. */
6893
+ readonly user: UserSettingsService;
6586
6894
  /**
6587
6895
  * Creates an instance of the ConversationalAgent service.
6588
6896
  *
@@ -6655,66 +6963,5 @@ declare class ConversationalAgentService extends BaseService implements Conversa
6655
6963
  getFeatureFlags(): Promise<FeatureFlags>;
6656
6964
  }
6657
6965
 
6658
- /**
6659
- * UserService - Service for managing user profile and context settings
6660
- */
6661
-
6662
- /**
6663
- * Service for managing user profile and context settings
6664
- *
6665
- * User settings are passed to the agent for all conversations
6666
- * to provide user context (name, email, role, timezone, etc.).
6667
- *
6668
- * @internal
6669
- */
6670
- declare class UserService extends BaseService implements UserServiceModel {
6671
- /**
6672
- * Gets the current user's profile and context settings
6673
- *
6674
- * @returns Promise resolving to user settings object containing profile information
6675
- *
6676
- * @example
6677
- * ```typescript
6678
- * const userSettings = await userService.getSettings();
6679
- * console.log(userSettings.name); // User's name
6680
- * console.log(userSettings.email); // User's email
6681
- * console.log(userSettings.timezone); // User's timezone
6682
- * ```
6683
- */
6684
- getSettings(): Promise<UserSettingsGetResponse>;
6685
- /**
6686
- * Updates the current user's profile and context settings
6687
- *
6688
- * All fields are optional - only send the fields you want to change.
6689
- * Set fields to `null` to explicitly clear them.
6690
- * Omitting fields means no change.
6691
- *
6692
- * @param options - Fields to update
6693
- * @returns Promise resolving to updated user settings object
6694
- *
6695
- * @example
6696
- * ```typescript
6697
- * // Update specific fields
6698
- * const updatedUserSettings = await userService.updateSettings({
6699
- * name: 'John Doe',
6700
- * email: 'john@example.com',
6701
- * timezone: 'America/New_York'
6702
- * });
6703
- *
6704
- * // Partial update - only change timezone
6705
- * await userService.updateSettings({
6706
- * timezone: 'Europe/London'
6707
- * });
6708
- *
6709
- * // Clear fields by setting to null
6710
- * await userService.updateSettings({
6711
- * role: null,
6712
- * department: null
6713
- * });
6714
- * ```
6715
- */
6716
- updateSettings(options: UserSettingsUpdateOptions): Promise<UserSettingsUpdateResponse>;
6717
- }
6718
-
6719
- export { AgentMap, AsyncInputStreamEventHelper, AsyncInputStreamEventHelperImpl, AsyncToolCallEventHelper, AsyncToolCallEventHelperImpl, CitationErrorType, ContentPartEventHelper, ContentPartEventHelperImpl, ContentPartHelper, ConversationEventHelperBase, ConversationEventHelperManager, ConversationEventHelperManagerImpl, ConversationEventInvalidOperationError, ConversationEventValidationError, ConversationMap, ConversationalAgentService as ConversationalAgent, ConversationalAgentService, EventErrorId, ExchangeEventHelper, ExchangeEventHelperImpl, ExchangeMap, ExchangeService, ExchangeService as Exchanges, FeedbackRating, InputStreamSpeechSensitivity, InterruptType, MessageEventHelper, MessageEventHelperImpl, MessageMap, MessageRole, MessageService, MessageService as Messages, SessionEventHelper, SessionEventHelperImpl, SortOrder, ToolCallEventHelper, ToolCallEventHelperImpl, UserService as User, UserService, UserSettingsMap, assertCitationSourceMedia, assertCitationSourceUrl, assertExternalValue, assertInlineValue, createAgentWithMethods, createConversationWithMethods, isCitationSourceMedia, isCitationSourceUrl, isExternalValue, isInlineValue, transformExchange, transformExchanges, transformMessage };
6720
- export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, AnyErrorEndHandler, AnyErrorEndHandlerArgs, AnyErrorStartHandler, AnyErrorStartHandlerArgs, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamChunkHandler, AsyncInputStreamEndEvent, AsyncInputStreamEndHandler, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStartHandler, AsyncToolCallStartHandlerAsync, AsyncToolCallStream, ChunkHandler, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartCompletedHandler, ContentPartData, ContentPartEndEvent, ContentPartEndHandler, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartEventOptions, ContentPartStartEventWithData, ContentPartStartHandler, ContentPartStartHandlerAsync, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationEventEmitter, ConversationEventErrorSource, ConversationEventHandler, ConversationEventHelperManagerConfig, ConversationEventHelperProperties, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, DeletedHandler, ErrorEndEvent, ErrorEndEventOptions, ErrorEndHandler, ErrorEndHandlerArgs, ErrorEvent, ErrorStartEvent, ErrorStartEventOptions, ErrorStartHandler, ErrorStartHandlerArgs, Exchange, ExchangeEndEvent, ExchangeEndHandler, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStartEventOptions, ExchangeStartHandler, ExchangeStartHandlerAsync, ExchangeStream, ExternalValue, FeatureFlags, FeedbackCreateResponse, FileUploadAccess, GenericInterruptStartEvent, InlineOrExternalValue, InlineValue, InputStreamStartEventOptions, InputStreamStartHandler, Interrupt, InterruptCompletedHandler, InterruptCompletedHandlerArgs, InterruptEndEvent, InterruptEndHandler, InterruptEndHandlerArgs, InterruptEvent, InterruptStartEvent, InterruptStartHandler, InterruptStartHandlerArgs, JSONArray, JSONObject, JSONPrimitive, JSONValue, LabelUpdatedEvent, LabelUpdatedHandler, MakeOptional, MakeRequired, Message, MessageCompletedHandler, MessageEndEvent, MessageEndHandler, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStartEventOptions, MessageStartHandler, MessageStartHandlerAsync, MessageStream, MetaData, MetaEvent, MetaEventHandler, RawAgentGetByIdResponse, RawAgentGetResponse, RawConversationGetResponse, SendMessageWithContentPartOptions, SessionCapabilities, SessionEndEvent, SessionEndHandler, SessionEndingEvent, SessionEndingHandler, SessionStartEvent, SessionStartEventOptions, SessionStartHandler, SessionStartHandlerAsync, SessionStartedEvent, SessionStartedHandler, SessionStream, Simplify, ToolCall, ToolCallCompletedHandler, ToolCallConfirmationEndValue, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEndHandler, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStartEventWithId, ToolCallStartHandler, ToolCallStartHandlerAsync, ToolCallStream, UnhandledErrorEndHandler, UnhandledErrorEndHandlerArgs, UnhandledErrorStartHandler, UnhandledErrorStartHandlerArgs, UserServiceModel, UserSettingsGetResponse, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
6966
+ export { AgentMap, AsyncInputStreamEventHelper, AsyncInputStreamEventHelperImpl, AsyncToolCallEventHelper, AsyncToolCallEventHelperImpl, CitationErrorType, ContentPartEventHelper, ContentPartEventHelperImpl, ContentPartHelper, ConversationEventHelperBase, ConversationEventHelperManager, ConversationEventHelperManagerImpl, ConversationEventInvalidOperationError, ConversationEventValidationError, ConversationMap, ConversationalAgentService as ConversationalAgent, ConversationalAgentService, EventErrorId, ExchangeEventHelper, ExchangeEventHelperImpl, ExchangeMap, ExchangeService, ExchangeService as Exchanges, FeedbackRating, InputStreamSpeechSensitivity, InterruptType, MessageEventHelper, MessageEventHelperImpl, MessageMap, MessageRole, MessageService, MessageService as Messages, SessionEventHelper, SessionEventHelperImpl, SortOrder, ToolCallEventHelper, ToolCallEventHelperImpl, UserSettingsService as UserSettings, UserSettingsMap, UserSettingsService, assertCitationSourceMedia, assertCitationSourceUrl, assertExternalValue, assertInlineValue, createAgentWithMethods, createConversationWithMethods, isCitationSourceMedia, isCitationSourceUrl, isExternalValue, isInlineValue, transformExchange, transformExchanges, transformMessage };
6967
+ export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, AnyErrorEndHandler, AnyErrorEndHandlerArgs, AnyErrorStartHandler, AnyErrorStartHandlerArgs, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamChunkHandler, AsyncInputStreamEndEvent, AsyncInputStreamEndHandler, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStartHandler, AsyncToolCallStartHandlerAsync, AsyncToolCallStream, ChunkHandler, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartCompletedHandler, ContentPartData, ContentPartEndEvent, ContentPartEndHandler, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartEventOptions, ContentPartStartEventWithData, ContentPartStartHandler, ContentPartStartHandlerAsync, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationEventEmitter, ConversationEventErrorSource, ConversationEventHandler, ConversationEventHelperManagerConfig, ConversationEventHelperProperties, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, DeletedHandler, ErrorEndEvent, ErrorEndEventOptions, ErrorEndHandler, ErrorEndHandlerArgs, ErrorEvent, ErrorStartEvent, ErrorStartEventOptions, ErrorStartHandler, ErrorStartHandlerArgs, Exchange, ExchangeEndEvent, ExchangeEndHandler, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStartEventOptions, ExchangeStartHandler, ExchangeStartHandlerAsync, ExchangeStream, ExternalValue, FeatureFlags, FeedbackCreateResponse, FileUploadAccess, GenericInterruptStartEvent, InlineOrExternalValue, InlineValue, InputStreamStartEventOptions, InputStreamStartHandler, Interrupt, InterruptCompletedHandler, InterruptCompletedHandlerArgs, InterruptEndEvent, InterruptEndHandler, InterruptEndHandlerArgs, InterruptEvent, InterruptStartEvent, InterruptStartHandler, InterruptStartHandlerArgs, JSONArray, JSONObject, JSONPrimitive, JSONValue, LabelUpdatedEvent, LabelUpdatedHandler, MakeOptional, MakeRequired, Message, MessageCompletedHandler, MessageEndEvent, MessageEndHandler, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStartEventOptions, MessageStartHandler, MessageStartHandlerAsync, MessageStream, MetaData, MetaEvent, MetaEventHandler, RawAgentGetByIdResponse, RawAgentGetResponse, RawConversationGetResponse, SendMessageWithContentPartOptions, SessionCapabilities, SessionEndEvent, SessionEndHandler, SessionEndingEvent, SessionEndingHandler, SessionStartEvent, SessionStartEventOptions, SessionStartHandler, SessionStartHandlerAsync, SessionStartedEvent, SessionStartedHandler, SessionStream, Simplify, ToolCall, ToolCallCompletedHandler, ToolCallConfirmHandler, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationHandler, ToolCallConfirmationHandlerArgs, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEndHandler, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStartEventWithId, ToolCallStartHandler, ToolCallStartHandlerAsync, ToolCallStream, UnhandledErrorEndHandler, UnhandledErrorEndHandlerArgs, UnhandledErrorStartHandler, UnhandledErrorStartHandlerArgs, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };