@uipath/uipath-typescript 1.5.0 → 1.5.1

package/dist/notifications/index.d.ts

@@ -0,0 +1,615 @@
+import { IUiPath } from '../core/index';
+
+/**
+ * Simplified universal pagination cursor
+ * Used to fetch next/previous pages
+ */
+interface PaginationCursor {
+    /** Opaque string containing all information needed to fetch next page */
+    value: string;
+}
+/**
+ * Discriminated union for pagination methods - ensures cursor and jumpToPage are mutually exclusive
+ */
+type PaginationMethodUnion = {
+    cursor?: PaginationCursor;
+    jumpToPage?: never;
+} | {
+    cursor?: never;
+    jumpToPage?: number;
+} | {
+    cursor?: never;
+    jumpToPage?: never;
+};
+/**
+ * Pagination options. Users cannot specify both cursor and jumpToPage.
+ */
+type PaginationOptions = {
+    /** Size of the page to fetch (items per page) */
+    pageSize?: number;
+} & PaginationMethodUnion;
+/**
+ * Paginated response containing items and navigation information
+ */
+interface PaginatedResponse<T> {
+    /** The items in the current page */
+    items: T[];
+    /** Total count of items across all pages (if available) */
+    totalCount?: number;
+    /** Whether more pages are available */
+    hasNextPage: boolean;
+    /** Cursor to fetch the next page (if available) */
+    nextCursor?: PaginationCursor;
+    /** Cursor to fetch the previous page (if available) */
+    previousCursor?: PaginationCursor;
+    /** Current page number (1-based, if available) */
+    currentPage?: number;
+    /** Total number of pages (if available) */
+    totalPages?: number;
+    /** 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
+ */
+declare enum PaginationType {
+    OFFSET = "offset",
+    TOKEN = "token"
+}
+/**
+ * Interface for service access methods needed by pagination helpers
+ */
+interface PaginationServiceAccess {
+    get<T>(path: string, options?: any): Promise<{
+        data: T;
+    }>;
+    post<T>(path: string, body?: any, options?: any): Promise<{
+        data: T;
+    }>;
+    requestWithPagination<T>(method: string, path: string, paginationOptions: PaginationOptions, options: RequestWithPaginationOptions): Promise<PaginatedResponse<T>>;
+}
+/**
+ * Field names for extracting data from paginated responses.
+ */
+interface PaginationFieldNames {
+    itemsField?: string;
+    totalCountField?: string;
+    continuationTokenField?: string;
+}
+/**
+ * Options for the requestWithPagination method in BaseService.
+ */
+interface RequestWithPaginationOptions extends RequestSpec {
+    pagination: PaginationFieldNames & {
+        paginationType: PaginationType;
+        paginationParams?: {
+            pageSizeParam?: string;
+            offsetParam?: string;
+            tokenParam?: string;
+            countParam?: string;
+            convertToSkip?: boolean;
+            zeroBased?: boolean;
+        };
+    };
+}
+
+/**
+ * HTTP methods supported by the API client
+ */
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+/**
+ * Supported response types for API requests
+ */
+type ResponseType = 'json' | 'text' | 'blob' | 'arraybuffer' | 'stream';
+/**
+ * Query parameters type with support for arrays and nested objects
+ */
+type QueryParams = Record<string, string | number | boolean | Array<string | number | boolean> | null | undefined>;
+/**
+ * Standard HTTP headers type
+ */
+type Headers = Record<string, string>;
+/**
+ * Options for request retries
+ */
+interface RetryOptions {
+    /** Maximum number of retry attempts */
+    maxRetries?: number;
+    /** Base delay between retries in milliseconds */
+    retryDelay?: number;
+    /** Whether to use exponential backoff */
+    useExponentialBackoff?: boolean;
+    /** Status codes that should trigger a retry */
+    retryableStatusCodes?: number[];
+}
+/**
+ * Options for request timeouts
+ */
+interface TimeoutOptions {
+    /** Request timeout in milliseconds */
+    timeout?: number;
+    /** Whether to abort the request on timeout */
+    abortOnTimeout?: boolean;
+}
+/**
+ * Options for request body transformation
+ */
+interface BodyOptions {
+    /** Whether to stringify the body */
+    stringify?: boolean;
+    /** Content type override */
+    contentType?: string;
+}
+/**
+ * Pagination metadata for API requests
+ */
+interface PaginationMetadata {
+    /** Type of pagination used by the API endpoint */
+    paginationType: PaginationType;
+    /** Response field containing items array (defaults to 'value') */
+    itemsField?: string;
+    /** Response field containing total count (defaults to '@odata.count') */
+    totalCountField?: string;
+    /** Response field containing continuation token (defaults to 'continuationToken') */
+    continuationTokenField?: string;
+}
+/**
+ * Base interface for all API requests
+ */
+interface RequestSpec {
+    /** HTTP method for the request */
+    method?: HttpMethod;
+    /** URL endpoint for the request */
+    url?: string;
+    /** Query parameters to be appended to the URL */
+    params?: QueryParams;
+    /** HTTP headers to include with the request */
+    headers?: Headers;
+    /** Raw body content (takes precedence over data) */
+    body?: unknown;
+    /** Expected response type */
+    responseType?: ResponseType;
+    /** Request timeout options */
+    timeoutOptions?: TimeoutOptions;
+    /** Retry behavior options */
+    retryOptions?: RetryOptions;
+    /** Body transformation options */
+    bodyOptions?: BodyOptions;
+    /** AbortSignal for cancelling the request */
+    signal?: AbortSignal;
+    /** Pagination metadata for the request */
+    pagination?: PaginationMetadata;
+}
+
+interface ApiResponse<T> {
+    data: T;
+}
+/**
+ * Base class for all UiPath SDK services.
+ *
+ * Provides common functionality for authentication, configuration, and API communication.
+ * All service classes extend this base to inherit dependency injection and HTTP client access.
+ *
+ * This class implements the dependency injection pattern where services receive a configured
+ * UiPath instance. The ApiClient is created internally and handles all HTTP operations
+ * including authentication token management.
+ *
+ * @remarks
+ * Service classes should extend this base and call `super(uiPath)` in their constructor.
+ * Protected HTTP methods (get, post, put, patch, delete) are available to all subclasses.
+ *
+ */
+declare class BaseService {
+    #private;
+    /**
+     * SDK configuration (read-only). Available to subclasses so they can
+     * fall back to init-time defaults like `folderKey`.
+     */
+    protected readonly config: {
+        folderKey?: string;
+    };
+    /**
+     * Creates a base service instance with dependency injection.
+     *
+     * Extracts configuration, execution context, and token manager from the UiPath instance
+     * to initialize an authenticated API client. The ApiClient handles all HTTP operations
+     * and token management internally.
+     *
+     * @param instance - UiPath SDK instance providing authentication and configuration.
+     *                    Services receive this via dependency injection in the modular pattern.
+     * @param headers - Optional default headers to include in every request (e.g. `x-uipath-external-user-id` for
+     *                  CAS external-app auth)
+     *
+     * @example
+     * ```typescript
+     * // Services automatically call this via super()
+     * export class EntityService extends BaseService {
+     *   constructor(instance: IUiPath) {
+     *     super(instance); // Initializes the internal ApiClient
+     *   }
+     * }
+     *
+     * // Usage in modular pattern
+     * import { UiPath } from '@uipath/uipath-typescript/core';
+     * import { Entities } from '@uipath/uipath-typescript/entities';
+     *
+     * const sdk = new UiPath(config);
+     * await sdk.initialize();
+     * const entities = new Entities(sdk);
+     * ```
+     */
+    constructor(instance: IUiPath, headers?: Record<string, string>);
+    /**
+     * Gets a valid authentication token, refreshing if necessary.
+     * Use this when you need to manually add Authorization headers (e.g., direct uploads).
+     *
+     * @returns Promise resolving to a valid access token string
+     * @throws AuthenticationError if no token is available or refresh fails
+     */
+    protected getValidAuthToken(): Promise<string>;
+    /**
+     * Creates a service accessor for pagination helpers
+     * This allows pagination helpers to access protected methods without making them public
+     */
+    protected createPaginationServiceAccess(): PaginationServiceAccess;
+    protected request<T>(method: string, path: string, options?: RequestSpec): Promise<ApiResponse<T>>;
+    protected requestWithSpec<T>(spec: RequestSpec): Promise<ApiResponse<T>>;
+    protected get<T>(path: string, options?: RequestSpec): Promise<ApiResponse<T>>;
+    protected post<T>(path: string, data?: unknown, options?: RequestSpec): Promise<ApiResponse<T>>;
+    protected put<T>(path: string, data?: unknown, options?: RequestSpec): Promise<ApiResponse<T>>;
+    protected patch<T>(path: string, data?: unknown, options?: RequestSpec): Promise<ApiResponse<T>>;
+    protected delete<T>(path: string, options?: RequestSpec): Promise<ApiResponse<T>>;
+    /**
+     * Execute a request with cursor-based pagination
+     */
+    protected requestWithPagination<T>(method: string, path: string, paginationOptions: PaginationOptions, options: RequestWithPaginationOptions): Promise<PaginatedResponse<T>>;
+    /**
+     * Validates and prepares pagination parameters from options
+     */
+    private validateAndPreparePaginationParams;
+    /**
+     * Prepares request parameters for pagination based on pagination type
+     */
+    private preparePaginationRequestParams;
+    /**
+     * Creates a paginated response from API response
+     */
+    private createPaginatedResponseFromResponse;
+    /**
+     * Determines if there are more pages based on pagination type and metadata
+     */
+    private determineHasMorePages;
+}
+
+/**
+ * Standardized result interface for all operation methods (pause, cancel, complete, update, upload, etc.)
+ * Success responses include data from the request context or API response
+ */
+interface OperationResponse<TData> {
+    /**
+     * Whether the operation was successful
+     */
+    success: boolean;
+    /**
+     * Response data (can contain error details in case of failure)
+     */
+    data: TData;
+}
+
+/**
+ * Notification inbox types — raw API shapes and request/response options.
+ */
+
+/**
+ * Priority level assigned to a notification by the publisher.
+ */
+declare enum NotificationPriority {
+    Low = "Low",
+    Medium = "Medium",
+    High = "High",
+    Critical = "Critical"
+}
+/**
+ * Severity classification of a notification topic.
+ */
+declare enum NotificationCategory {
+    /** Informational — no action required. */
+    Info = "Info",
+    /** Successful operation completed. */
+    Success = "Success",
+    /** Warning — degraded behaviour or non-fatal issue. */
+    Warn = "Warn",
+    /** Error — operation failed but the system continues. */
+    Error = "Error",
+    /** Fatal — unrecoverable failure. */
+    Fatal = "Fatal"
+}
+/**
+ * Notification entry as returned by `GET /odata/v1/NotificationEntry`.
+ *
+ * Field selection: many internal/transport-layer fields (`partitionKey`, `correlationId`,
+ * `publicationId`, `messageVersion`, `messageTemplateKey`, `serviceRegistryName`,
+ * `entityOrgName`, `entityTenantName`) are returned by the API but dropped from the SDK
+ * because they have no use for an application developer.
+ */
+interface NotificationGetResponse {
+    /** Notification GUID. */
+    id: string;
+    /** Resolved notification message text. */
+    message: string | null;
+    /** Whether the user has read this notification. */
+    hasRead: boolean;
+    /** Name of the publisher (e.g. `Orchestrator`, `Actions`). */
+    publisherName: string;
+    /** Publisher GUID. */
+    publisherId: string;
+    /** Human-readable topic name. */
+    topicName: string;
+    /** Stable topic identifier (e.g. `Process.JobExecution.Faulted`). */
+    topicKeyName: string;
+    /** Topic GUID. */
+    topicId: string;
+    /** GUID of the user this notification belongs to (returned uppercase by the API). */
+    userId: string;
+    /** Email of the user. Often `null`. */
+    userEmail: string | null;
+    /** Tenant GUID this notification belongs to. Often `null` for org-scoped notifications. */
+    tenantId: string | null;
+    /** Notification priority. */
+    priority: NotificationPriority;
+    /** Notification severity category. */
+    category: NotificationCategory;
+    /** JSON string of template parameters — parse with `JSON.parse()`. May be `null`. */
+    messageParam: string | null;
+    /** URL to navigate to when the notification is clicked. */
+    redirectionUrl: string | null;
+    /** Unix epoch **seconds** when the notification was published. */
+    publishedOn: number;
+}
+/**
+ * Options for `Notifications.getAll()`.
+ *
+ * Supports OData query options (`filter`, `orderby`) and SDK cursor pagination.
+ *
+ * Notes:
+ * - `$select` and `$expand` are not exposed because the API returns 500 on `$select`
+ *   and there are no expandable relationships on this endpoint.
+ */
+type NotificationGetAllOptions = PaginationOptions & {
+    filter?: string;
+    orderby?: string;
+};
+/**
+ * Response from `markAsRead()` / `markAsUnread()`.
+ *
+ * `notificationIds` echoes the IDs that were marked; `read` reflects the new state.
+ */
+type NotificationUpdateReadResponse = OperationResponse<{
+    notificationIds: string[];
+    read: boolean;
+}>;
+/**
+ * Response from `markAllAsRead()`.
+ */
+type NotificationMarkAllReadResponse = OperationResponse<{
+    all: true;
+    read: true;
+}>;
+
+/**
+ * Notification service model — public response shapes and the ServiceModel interface
+ * that drives generated API documentation.
+ */
+
+/**
+ * Public surface of the Notifications service. JSDoc on this interface drives
+ * the generated API reference documentation.
+ *
+ * Every method takes the tenant GUID as the first argument — the notification
+ * API identifies the acting tenant via the `X-UIPATH-Internal-TenantId` header
+ * and the SDK forwards `tenantId` into that header on each call.
+ */
+interface NotificationServiceModel {
+    /**
+     * Lists notifications from the current user's inbox.
+     *
+     * Returns the full list when no pagination params are provided, or a paginated cursor result
+     * when any of `pageSize`/`cursor`/`jumpToPage` is supplied. Supports OData `filter` and
+     * `orderby` query options.
+     *
+     * @param tenantId - Tenant GUID
+     * @param options - Optional OData query and pagination options
+     * @returns Promise resolving to either a {@link NonPaginatedResponse}<{@link NotificationGetResponse}> or a {@link PaginatedResponse}<{@link NotificationGetResponse}> when pagination options are used.
+     *
+     * @example Basic usage
+     * ```typescript
+     * import { Notifications } from '@uipath/uipath-typescript/notifications';
+     *
+     * const notifications = new Notifications(sdk);
+     * const all = await notifications.getAll('<tenantId>');
+     * ```
+     *
+     * @example Filter unread, most recent first
+     * ```typescript
+     * const unread = await notifications.getAll('<tenantId>', {
+     *   filter: 'hasRead eq false',
+     *   orderby: 'publishedOn desc',
+     * });
+     * ```
+     *
+     * @example First page with pagination
+     * ```typescript
+     * const page1 = await notifications.getAll('<tenantId>', { pageSize: 20 });
+     * if (page1.hasNextPage) {
+     *   const page2 = await notifications.getAll('<tenantId>', { cursor: page1.nextCursor });
+     * }
+     * ```
+     * @internal
+     */
+    getAll<T extends NotificationGetAllOptions = NotificationGetAllOptions>(tenantId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<NotificationGetResponse> : NonPaginatedResponse<NotificationGetResponse>>;
+    /**
+     * Marks the given notifications as read.
+     *
+     * @param tenantId - Tenant GUID
+     * @param notificationIds - GUIDs of notifications to mark read
+     * @returns Operation result echoing the affected IDs and new read state
+     * {@link NotificationUpdateReadResponse}
+     *
+     * @example
+     * ```typescript
+     * await notifications.markAsRead('<tenantId>', ['<notificationId-1>', '<notificationId-2>']);
+     * ```
+     * @internal
+     */
+    markAsRead(tenantId: string, notificationIds: string[]): Promise<NotificationUpdateReadResponse>;
+    /**
+     * Marks the given notifications as unread.
+     *
+     * @param tenantId - Tenant GUID
+     * @param notificationIds - GUIDs of notifications to mark unread
+     * @returns Operation result echoing the affected IDs and new read state
+     * {@link NotificationUpdateReadResponse}
+     *
+     * @example
+     * ```typescript
+     * await notifications.markAsUnread('<tenantId>', ['<notificationId>']);
+     * ```
+     * @internal
+     */
+    markAsUnread(tenantId: string, notificationIds: string[]): Promise<NotificationUpdateReadResponse>;
+    /**
+     * Marks all notifications in the current user's inbox as read.
+     *
+     * @param tenantId - Tenant GUID
+     * @returns Operation result confirming the bulk update
+     * {@link NotificationMarkAllReadResponse}
+     *
+     * @example
+     * ```typescript
+     * await notifications.markAllAsRead('<tenantId>');
+     * ```
+     * @internal
+     */
+    markAllAsRead(tenantId: string): Promise<NotificationMarkAllReadResponse>;
+}
+
+/**
+ * NotificationService — manages the current user's notification inbox.
+ */
+
+/**
+ * Service for interacting with the UiPath Notification inbox.
+ *
+ * Provides inbox operations against the current user's notifications (the
+ * `/odata/v1/NotificationEntry` API).
+ *
+ * Every public method takes the acting tenant GUID as the first argument — the
+ * notification API identifies the tenant via the `X-UIPATH-Internal-TenantId`
+ * header and the SDK forwards `tenantId` into that header on each call.
+ */
+declare class NotificationService extends BaseService implements NotificationServiceModel {
+    /**
+     * Lists notifications from the current user's inbox.
+     *
+     * Returns the full list when no pagination params are provided, or a paginated cursor result
+     * when any of `pageSize`/`cursor`/`jumpToPage` is supplied. Supports OData `filter` and
+     * `orderby` query options.
+     *
+     * @param tenantId - Tenant GUID
+     * @param options - Optional OData query and pagination options
+     * @returns Promise resolving to either a {@link NonPaginatedResponse}<{@link NotificationGetResponse}> or a {@link PaginatedResponse}<{@link NotificationGetResponse}> when pagination options are used.
+     *
+     * @example Basic usage
+     * ```typescript
+     * import { Notifications } from '@uipath/uipath-typescript/notifications';
+     *
+     * const notifications = new Notifications(sdk);
+     * const all = await notifications.getAll('<tenantId>');
+     * ```
+     *
+     * @example Filter unread, most recent first
+     * ```typescript
+     * const unread = await notifications.getAll('<tenantId>', {
+     *   filter: 'hasRead eq false',
+     *   orderby: 'publishedOn desc',
+     * });
+     * ```
+     *
+     * @example First page with pagination
+     * ```typescript
+     * const page1 = await notifications.getAll('<tenantId>', { pageSize: 20 });
+     * if (page1.hasNextPage) {
+     *   const page2 = await notifications.getAll('<tenantId>', { cursor: page1.nextCursor });
+     * }
+     * ```
+     * @internal
+     */
+    getAll<T extends NotificationGetAllOptions = NotificationGetAllOptions>(tenantId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<NotificationGetResponse> : NonPaginatedResponse<NotificationGetResponse>>;
+    /**
+     * Marks the given notifications as read.
+     *
+     * @param tenantId - Tenant GUID
+     * @param notificationIds - GUIDs of notifications to mark read
+     * @returns Operation result echoing the affected IDs and new read state
+     * {@link NotificationUpdateReadResponse}
+     *
+     * @example
+     * ```typescript
+     * await notifications.markAsRead('<tenantId>', ['<notificationId-1>', '<notificationId-2>']);
+     * ```
+     * @internal
+     */
+    markAsRead(tenantId: string, notificationIds: string[]): Promise<NotificationUpdateReadResponse>;
+    /**
+     * Marks the given notifications as unread.
+     *
+     * @param tenantId - Tenant GUID
+     * @param notificationIds - GUIDs of notifications to mark unread
+     * @returns Operation result echoing the affected IDs and new read state
+     * {@link NotificationUpdateReadResponse}
+     *
+     * @example
+     * ```typescript
+     * await notifications.markAsUnread('<tenantId>', ['<notificationId>']);
+     * ```
+     * @internal
+     */
+    markAsUnread(tenantId: string, notificationIds: string[]): Promise<NotificationUpdateReadResponse>;
+    /**
+     * Marks all notifications in the current user's inbox as read.
+     *
+     * @param tenantId - Tenant GUID
+     * @returns Operation result confirming the bulk update
+     * {@link NotificationMarkAllReadResponse}
+     *
+     * @example
+     * ```typescript
+     * await notifications.markAllAsRead('<tenantId>');
+     * ```
+     * @internal
+     */
+    markAllAsRead(tenantId: string): Promise<NotificationMarkAllReadResponse>;
+    private updateRead;
+}
+
+export { NotificationCategory, NotificationPriority, NotificationService as Notifications };
+export type { NotificationGetAllOptions, NotificationGetResponse, NotificationMarkAllReadResponse, NotificationServiceModel, NotificationUpdateReadResponse };