@uipath/uipath-typescript 1.3.11 → 1.4.0

package/dist/conversational-agent/index.d.ts

@@ -52,24 +52,6 @@ interface PaginatedResponse<T> {
     /** Whether this pagination type supports jumping to arbitrary pages */
     supportsPageJump: boolean;
 }
-/**
- * Response for non-paginated calls that includes both data and total count
- */
-interface NonPaginatedResponse<T> {
-    items: T[];
-    totalCount?: number;
-}
-/**
- * Helper type for defining paginated method overloads
- * Creates a union type of all ways pagination can be triggered
- */
-type HasPaginationOptions<T> = (T & {
-    pageSize: number;
-}) | (T & {
-    cursor: PaginationCursor;
-}) | (T & {
-    jumpToPage: number;
-});
 
 /**
  * Pagination types supported by the SDK
@@ -110,6 +92,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
             tokenParam?: string;
             countParam?: string;
             convertToSkip?: boolean;
+            zeroBased?: boolean;
         };
     };
 }
@@ -746,11 +729,12 @@ interface Exchange {
 }
 /**
  * Optional configuration options for when the service automatically starts agent job(s) to serve the conversation.
- * When not provided, service uses default configuration with RunAsMe set to false.
+ * When not provided, service uses recommended default configurations.
  */
 interface ConversationJobStartOverrides {
     /**
-     * Whether the job(s) should run with the user's identity (RunAsMe). Defaults to false when not provided.
+     * Whether the job(s) should run with the user's identity (RunAsMe). When not provided, service
+     * uses recommended default based on authentication-state and process-runtime.
      */
     runAsMe?: boolean;
 }
@@ -855,30 +839,11 @@ interface ContentPartInterrupted {
  */
 interface SessionCapabilities {
     /**
-     * Indicates the sender may produce a cross exchange input stream events if the receiver indicates they can be handled.
+     * Indicates that a client is prepared to handle events for exchanges initiated by service-role messages.
+     * When set to true, the client will receive events for the service-role message and any assistant-role messages
+     * sent in response to it within the exchange.
      */
-    asyncInputStreamEmitter?: boolean;
-    /**
-     * Indicates the sender can handle cross exchange input stream events.
-     */
-    asyncInputStreamHandler?: boolean;
-    /**
-     * Indicates the sender may produce cross exchange tool calls if the receiver indicates they can be handled.
-     */
-    asyncToolCallEmitter?: boolean;
-    /**
-     * Indicates the sender can handle cross exchange tool calls.
-     */
-    asyncToolCallHandler?: boolean;
-    /**
-     * Indicates the mime types which the sender can send in input streams and as message content, provided the receiver
-     * indicates they can handle the mime type.
-     */
-    mimeTypesEmitted?: string[];
-    /**
-     * Indicates the mime types the sender can handle. Wildcards such as "*\/*" and "text/*" are allowed.
-     */
-    mimeTypesHandled?: string[];
+    serviceMessageClient?: boolean;
     /** Allow custom properties */
     [key: string]: unknown;
 }
@@ -3668,28 +3633,49 @@ interface FeedbackCreateResponse {
  */
 interface ExchangeServiceModel {
     /**
-     * Gets all exchanges for a conversation with optional filtering and pagination
+     * Gets exchanges for a conversation with pagination and optional sort parameters
+     *
+     * Returns a paginated response. When called without `pageSize`/`cursor`, the
+     * backend applies its default page size — inspect `hasNextPage`/`nextCursor`
+     * to navigate further pages.
      *
      * @param conversationId - The conversation ID to get exchanges for
      * @param options - Options for querying exchanges including optional pagination parameters
-     * @returns Promise resolving to either an array of exchanges {@link NonPaginatedResponse}<{@link ExchangeGetResponse}> or a {@link PaginatedResponse}<{@link ExchangeGetResponse}> when pagination options are used
-     * @example
-     * ```typescript
-     * // Get all exchanges (non-paginated)
-     * const conversationExchanges = await exchanges.getAll(conversationId);
+     * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
      *
-     * // First page with pagination
-     * const firstPageOfExchanges = await exchanges.getAll(conversationId, { pageSize: 10 });
+     * @example Basic usage - default page size and sort order
+     * ```typescript
+     * // First page
+     * const firstPage = await exchanges.getAll(conversationId);
      *
      * // Navigate using cursor
-     * if (firstPageOfExchanges.hasNextPage) {
-     *   const nextPageOfExchanges = await exchanges.getAll(conversationId, {
-     *     cursor: firstPageOfExchanges.nextCursor
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await exchanges.getAll(conversationId, { cursor: firstPage.nextCursor });
+     * }
+     * ```
+     *
+     * @example With explicit page size and exchange/message sort orders
+     * ```typescript
+     * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
+     *
+     * const firstPage = await exchanges.getAll(conversationId, {
+     *   pageSize: 10,
+     *   exchangeSort: SortOrder.Descending,
+     *   messageSort: SortOrder.Ascending
+     * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await exchanges.getAll(conversationId, {
+     *     pageSize: 10,
+     *     exchangeSort: SortOrder.Descending,
+     *     messageSort: SortOrder.Ascending,
+     *     cursor: firstPage.nextCursor
      *   });
      * }
      * ```
      */
-    getAll<T extends ExchangeGetAllOptions = ExchangeGetAllOptions>(conversationId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ExchangeGetResponse> : NonPaginatedResponse<ExchangeGetResponse>>;
+    getAll(conversationId: string, options?: ExchangeGetAllOptions): Promise<PaginatedResponse<ExchangeGetResponse>>;
     /**
      * Gets an exchange by ID with its messages
      *
@@ -3733,26 +3719,53 @@ interface ExchangeServiceModel {
  */
 interface ConversationExchangeServiceModel {
     /**
-     * Gets all exchanges for this conversation with optional filtering and pagination
+     * Gets exchanges for this conversation with pagination and optional sort parameters
+     *
+     * Returns a paginated response. When called without `pageSize`/`cursor`, the
+     * backend applies its default page size — inspect `hasNextPage`/`nextCursor`
+     * to navigate further pages.
      *
      * @param options - Options for querying exchanges including optional pagination parameters
-     * @returns Promise resolving to either an array of exchanges or a paginated response
+     * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
      *
-     * @example
+     * @example Basic usage - default page size and sort order
      * ```typescript
      * const conversation = await conversationalAgent.conversations.getById(conversationId);
      *
-     * // Get all exchanges
-     * const allExchanges = await conversation.exchanges.getAll();
+     * // First page
+     * const firstPage = await conversation.exchanges.getAll();
      *
-     * // With pagination
-     * const firstPage = await conversation.exchanges.getAll({ pageSize: 10 });
+     * // Navigate using cursor
      * if (firstPage.hasNextPage) {
      *   const nextPage = await conversation.exchanges.getAll({ cursor: firstPage.nextCursor });
      * }
      * ```
+     *
+     * @example With explicit page size and exchange/message sort orders
+     * ```typescript
+     * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
+     *
+     * const conversation = await conversationalAgent.conversations.getById(conversationId);
+     *
+     * // First page
+     * const firstPage = await conversation.exchanges.getAll({
+     *   pageSize: 10,
+     *   exchangeSort: SortOrder.Descending,
+     *   messageSort: SortOrder.Ascending
+     * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await conversation.exchanges.getAll({
+     *     pageSize: 10,
+     *     exchangeSort: SortOrder.Descending,
+     *     messageSort: SortOrder.Ascending,
+     *     cursor: firstPage.nextCursor
+     *   });
+     * }
+     * ```
      */
-    getAll<T extends ExchangeGetAllOptions = ExchangeGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ExchangeGetResponse> : NonPaginatedResponse<ExchangeGetResponse>>;
+    getAll(options?: ExchangeGetAllOptions): Promise<PaginatedResponse<ExchangeGetResponse>>;
     /**
      * Gets an exchange by ID with its messages
      *
@@ -3883,28 +3896,23 @@ interface ConversationServiceModel {
      */
     create(agentId: number, folderId: number, options?: ConversationCreateOptions): Promise<ConversationCreateResponse>;
     /**
-     * Gets all conversations with optional filtering and pagination
+     * Gets conversations with pagination and optional sort/filter parameters
      *
-     * The method returns either:
-     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
-     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     * Returns a paginated response. When called without `pageSize`/`cursor`, a
+     * default page size is applied - inspect `hasNextPage`/`nextCursor`
+     * to navigate further pages.
      *
-     * @param options - Options for querying conversations including optional pagination parameters
-     * @returns Promise resolving to either an array of conversations {@link NonPaginatedResponse}<{@link ConversationGetResponse}> or a {@link PaginatedResponse}<{@link ConversationGetResponse}> when pagination options are used
+     * @param options - Options for querying conversations
+     * @returns Promise resolving to a {@link PaginatedResponse}<{@link ConversationGetResponse}>
      *
-     * @example Basic usage - get all conversations
+     * @example Basic usage - default sort, pagination, and without filtering
      * ```typescript
-     * const allConversations = await conversationalAgent.conversations.getAll();
+     * // First page
+     * const firstPage = await conversationalAgent.conversations.getAll();
      *
-     * for (const conversation of allConversations.items) {
+     * for (const conversation of firstPage.items) {
      *   console.log(`${conversation.label} - created: ${conversation.createdTime}`);
      * }
-     * ```
-     *
-     * @example With pagination
-     * ```typescript
-     * // First page
-     * const firstPage = await conversationalAgent.conversations.getAll({ pageSize: 10 });
      *
      * // Navigate using cursor
      * if (firstPage.hasNextPage) {
@@ -3914,23 +3922,44 @@ interface ConversationServiceModel {
      * }
      * ```
      *
-     * @example Sorted with limit
+     * @example With explicit page size and sort order (by last-activity timestamp)
      * ```typescript
-     * const result = await conversationalAgent.conversations.getAll({
-     *   sort: SortOrder.Descending,
-     *   pageSize: 20
+     * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
+     *
+     * // First page
+     * const firstPage = await conversationalAgent.conversations.getAll({
+     *   pageSize: 10,
+     *   sort: SortOrder.Descending
      * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await conversationalAgent.conversations.getAll({
+     *     pageSize: 10,
+     *     sort: SortOrder.Descending,
+     *     cursor: firstPage.nextCursor
+     *   });
+     * }
      * ```
      *
-     * @example Filter by agent and search by label
+     * @example With agent-filter and label-search
      * ```typescript
-     * const filtered = await conversationalAgent.conversations.getAll({
+     * const firstPage = await conversationalAgent.conversations.getAll({
      *   agentId: <agentId>,
      *   label: 'budget'
      * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await conversationalAgent.conversations.getAll({
+     *     agentId: <agentId>,
+     *     label: 'budget',
+     *     cursor: firstPage.nextCursor
+     *   });
+     * }
      * ```
      */
-    getAll<T extends ConversationGetAllOptions = ConversationGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ConversationGetResponse> : NonPaginatedResponse<ConversationGetResponse>>;
+    getAll(options?: ConversationGetAllOptions): Promise<PaginatedResponse<ConversationGetResponse>>;
     /**
      * Gets a conversation by ID
      *
@@ -4284,6 +4313,11 @@ interface ConversationSessionOptions {
      * ```
      */
     logLevel?: LogLevel;
+    /**
+     * Optional capabilities of this client to advertise to the service when starting the session.
+     * Generally not needed unless the client is accessing more advanced features.
+     */
+    capabilities?: SessionCapabilities;
 }
 /** Response for creating a conversation (includes methods) */
 interface ConversationCreateResponse extends ConversationGetResponse {
@@ -4319,7 +4353,7 @@ interface ConversationUpdateOptions {
     agentInput?: AgentInput;
 }
 type ConversationGetAllOptions = PaginationOptions & {
-    /** Sort order for conversations */
+    /** Sort order for conversations (by the last activity timestamp) */
     sort?: SortOrder;
     /** GUID key of the agent to filter conversations by. */
     agentKey?: string;
@@ -6434,28 +6468,23 @@ declare class ConversationService extends BaseService implements ConversationSer
      */
     getById(id: string): Promise<ConversationGetResponse>;
     /**
-     * Gets all conversations with optional filtering and pagination
+     * Gets conversations with pagination and optional sort/filter parameters
      *
-     * The method returns either:
-     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
-     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     * Returns a paginated response. When called without `pageSize`/`cursor`, a
+     * default page size is applied - inspect `hasNextPage`/`nextCursor`
+     * to navigate further pages.
      *
-     * @param options - Options for querying conversations including optional pagination parameters
-     * @returns Promise resolving to either an array of conversations {@link NonPaginatedResponse}<{@link ConversationGetResponse}> or a {@link PaginatedResponse}<{@link ConversationGetResponse}> when pagination options are used
+     * @param options - Options for querying conversations
+     * @returns Promise resolving to a {@link PaginatedResponse}<{@link ConversationGetResponse}>
      *
-     * @example Basic usage - get all conversations
+     * @example Basic usage - default sort, pagination, and without filtering
      * ```typescript
-     * const allConversations = await conversationalAgent.conversations.getAll();
+     * // First page
+     * const firstPage = await conversationalAgent.conversations.getAll();
      *
-     * for (const conversation of allConversations.items) {
+     * for (const conversation of firstPage.items) {
      *   console.log(`${conversation.label} - created: ${conversation.createdTime}`);
      * }
-     * ```
-     *
-     * @example With pagination
-     * ```typescript
-     * // First page
-     * const firstPage = await conversationalAgent.conversations.getAll({ pageSize: 10 });
      *
      * // Navigate using cursor
      * if (firstPage.hasNextPage) {
@@ -6465,23 +6494,44 @@ declare class ConversationService extends BaseService implements ConversationSer
      * }
      * ```
      *
-     * @example Sorted with limit
+     * @example With explicit page size and sort order (by last-activity timestamp)
      * ```typescript
-     * const result = await conversationalAgent.conversations.getAll({
-     *   sort: SortOrder.Descending,
-     *   pageSize: 20
+     * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
+     *
+     * // First page
+     * const firstPage = await conversationalAgent.conversations.getAll({
+     *   pageSize: 10,
+     *   sort: SortOrder.Descending
      * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await conversationalAgent.conversations.getAll({
+     *     pageSize: 10,
+     *     sort: SortOrder.Descending,
+     *     cursor: firstPage.nextCursor
+     *   });
+     * }
      * ```
      *
-     * @example Filter by agent and search by label
+     * @example With agent-filter and label-search
      * ```typescript
-     * const filtered = await conversationalAgent.conversations.getAll({
+     * const firstPage = await conversationalAgent.conversations.getAll({
      *   agentId: <agentId>,
      *   label: 'budget'
      * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await conversationalAgent.conversations.getAll({
+     *     agentId: <agentId>,
+     *     label: 'budget',
+     *     cursor: firstPage.nextCursor
+     *   });
+     * }
      * ```
      */
-    getAll<T extends ConversationGetAllOptions = ConversationGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ConversationGetResponse> : NonPaginatedResponse<ConversationGetResponse>>;
+    getAll(options?: ConversationGetAllOptions): Promise<PaginatedResponse<ConversationGetResponse>>;
     /**
      * Updates a conversation by ID
      *
@@ -6694,31 +6744,49 @@ declare class ExchangeService extends BaseService implements ExchangeServiceMode
      */
     constructor(instance: IUiPath$1, options?: ConversationalAgentOptions);
     /**
-     * Gets all exchanges for a conversation with optional filtering and pagination
+     * Gets exchanges for a conversation with pagination and optional sort parameters
      *
-     * The method returns either:
-     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
-     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     * Returns a paginated response. When called without `pageSize`/`cursor`, the
+     * backend applies its default page size — inspect `hasNextPage`/`nextCursor`
+     * to navigate further pages.
      *
      * @param conversationId - The conversation ID to get exchanges for
      * @param options - Options for querying exchanges including optional pagination parameters
-     * @returns Promise resolving to either an array of exchanges {@link NonPaginatedResponse}<{@link ExchangeGetResponse}> or a {@link PaginatedResponse}<{@link ExchangeGetResponse}> when pagination options are used
+     * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
      *
-     * @example
+     * @example Basic usage - default page size and sort order
      * ```typescript
-     * // Get all exchanges (non-paginated)
-     * const conversationExchanges = await exchanges.getAll(conversationId);
-     *
-     * // First page with pagination
-     * const firstPageOfExchanges = await exchanges.getAll(conversationId, { pageSize: 10 });
+     * // First page
+     * const firstPage = await exchanges.getAll(conversationId);
      *
      * // Navigate using cursor
-     * if (firstPageOfExchanges.hasNextPage) {
-     *   const nextPageOfExchanges = await exchanges.getAll(conversationId, { cursor: firstPageOfExchanges.nextCursor });
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await exchanges.getAll(conversationId, { cursor: firstPage.nextCursor });
+     * }
+     * ```
+     *
+     * @example With explicit page size and exchange/message sort orders
+     * ```typescript
+     * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
+     *
+     * const firstPage = await exchanges.getAll(conversationId, {
+     *   pageSize: 10,
+     *   exchangeSort: SortOrder.Descending,
+     *   messageSort: SortOrder.Ascending
+     * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await exchanges.getAll(conversationId, {
+     *     pageSize: 10,
+     *     exchangeSort: SortOrder.Descending,
+     *     messageSort: SortOrder.Ascending,
+     *     cursor: firstPage.nextCursor
+     *   });
      * }
      * ```
      */
-    getAll<T extends ExchangeGetAllOptions = ExchangeGetAllOptions>(conversationId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ExchangeGetResponse> : NonPaginatedResponse<ExchangeGetResponse>>;
+    getAll(conversationId: string, options?: ExchangeGetAllOptions): Promise<PaginatedResponse<ExchangeGetResponse>>;
     /**
      * Gets an exchange by ID with its messages
      *