@qlik/api 2.2.0 → 2.3.0

package/chunks/notes-BZxuyDgt.d.ts

@@ -1,111 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/notes.d.ts
-
-/**
- * The possible states for the status of notes configuration GET or POST operation
- */
-type ConfigReasonCode = "deployment" | "toggle" | "license";
-type Error = {
-  /** Error code specific to notes broker service. */
-  readonly code?: string;
-  /** Error cause. */
-  readonly detail?: string;
-  /** Error title. */
-  readonly title?: string;
-};
-/**
- * @example
- * {
- *   errors: [
- *     {
- *       code: "HTTP-123",
- *       title: "short error message"
- *     }
- *   ],
- *   traceId: "7326ce0d-1946-41d0-b890-609865cc42ea"
- * }
- */
-type Errors = {
-  errors?: Error[];
-  /** An optional traceId */
-  traceId?: string;
-};
-type NoteSettingsPutPayload = {
-  /** pass 'true' to enable the note toggle for the tenant, 'false' to disable the toggle (other values are ignore). */
-  toggledOn?: boolean;
-};
-type NoteSettingsPutResponse = {
-  /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
-  toggleOn?: boolean;
-};
-type NotesUserSettings = {
-  /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
-  available: boolean;
-  /** The timestamp for the last time this users notes settings were fetched from downstream services. */
-  lastFetch?: string;
-  /** The possible states for the status of notes configuration GET or POST operation */
-  reason?: ConfigReasonCode;
-};
-/**
- * Get the enablement status of the notes feature set for this tenant and user.
- *
- * @throws GetNotesSettingsHttpError
- */
-declare function getNotesSettings(options?: ApiCallOptions): Promise<GetNotesSettingsHttpResponse>;
-type GetNotesSettingsHttpResponse = {
-  data: NotesUserSettings;
-  headers: Headers;
-  status: 200;
-};
-type GetNotesSettingsHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: number;
-};
-/**
- * update the settings
- *
- * @param body an object with the body content
- * @throws SetNotesSettingsHttpError
- */
-declare function setNotesSettings(body: NoteSettingsPutPayload, options?: ApiCallOptions): Promise<SetNotesSettingsHttpResponse>;
-type SetNotesSettingsHttpResponse = {
-  data: NoteSettingsPutResponse;
-  headers: Headers;
-  status: 200;
-};
-type SetNotesSettingsHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: number;
-};
-/**
- * Clears the cache for notes api requests.
- */
-declare function clearCache(): void;
-type NotesAPI = {
-  /**
-   * Get the enablement status of the notes feature set for this tenant and user.
-   *
-   * @throws GetNotesSettingsHttpError
-   */
-  getNotesSettings: typeof getNotesSettings;
-  /**
-   * update the settings
-   *
-   * @param body an object with the body content
-   * @throws SetNotesSettingsHttpError
-   */
-  setNotesSettings: typeof setNotesSettings;
-  /**
-   * Clears the cache for notes api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the notes api
- */
-declare const notesExport: NotesAPI;
-//#endregion
-export { GetNotesSettingsHttpResponse as a, NotesAPI as c, SetNotesSettingsHttpResponse as d, clearCache as f, setNotesSettings as h, GetNotesSettingsHttpError as i, NotesUserSettings as l, notesExport as m, Error as n, NoteSettingsPutPayload as o, getNotesSettings as p, Errors as r, NoteSettingsPutResponse as s, ConfigReasonCode as t, SetNotesSettingsHttpError as u };

package/chunks/notifications-Bd_gp4jU.d.ts

@@ -1,99 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/notifications.d.ts
-
-/**
- * An error object.
- */
-type Error = {
-  /** The error code. */
-  code: string;
-  /** A human-readable explanation specific to this occurrence of the problem. */
-  detail?: string;
-  /** Summary of the problem. */
-  title: string;
-};
-/**
- * Notification result item
- */
-type NotificationItem = {
-  /** Indicates if the notification can be managed in the hub. If true, the object will also contain 'subscriptionInfo' object and a 'presentationInfo' object with a non-empty scopes array. */
-  isManageableInHub?: boolean;
-  /** Indicates if the notification can be subscribed to by users.  If true, the object will also contain 'subscriptionInfo' object */
-  isSubscribable: boolean;
-  /** Notification name pattern that will trigger this notification e.g resource.action */
-  notificationNamePattern: string;
-  /** Object containing information pertaining to the presentaion of a notification in the UI */
-  presentationInfo?: {
-    /** Localized, human-readable string representing the name of the notification suitable to use in a UI */
-    friendlyName?: string;
-    /** Friendly name to be displayed for each scope. */
-    scopeFriendlyNames?: Record<string, string>;
-    /** Information about the scopes to which this notification applies.  Helps determine the placement of the notification in the UI */
-    scopes?: string[];
-  };
-  /** Object indicating what properties to use to subscribe to this notification via the 'Subscriptions' service.  For info about its properties, refer to the Subscription sevice's API doc. */
-  subscriptionInfo?: {
-    action: string;
-    resourceId?: string;
-    resourceSubType?: string;
-    resourceType: string;
-    target?: string;
-  };
-  /** Type of Transport e.g. Email, Notification, Slack message etc... */
-  transports: string[];
-};
-/**
- * Object containing array representing list of supported notifications
- */
-type NotificationsObject = {
-  /** list of notifications */
-  notifications: NotificationItem[];
-};
-/**
- * List all supported notifications
- *
- * @param query an object with query parameters
- * @throws GetNotificationsHttpError
- */
-declare function getNotifications(query: {
-  /** If present, idenfies the language of the returned 'friendlyName' property. */
-  locale?: string;
-  /** If present, represents the 'manageableInHub' value to filter by. */
-  manageableInHub?: true | false;
-  /** If present, represents the 'subscribable' value to filter by. */
-  subscribable?: true | false;
-}, options?: ApiCallOptions): Promise<GetNotificationsHttpResponse>;
-type GetNotificationsHttpResponse = {
-  data: NotificationsObject;
-  headers: Headers;
-  status: 200;
-};
-type GetNotificationsHttpError = {
-  data: Error;
-  headers: Headers;
-  status: number;
-};
-/**
- * Clears the cache for notifications api requests.
- */
-declare function clearCache(): void;
-type NotificationsAPI = {
-  /**
-   * List all supported notifications
-   *
-   * @param query an object with query parameters
-   * @throws GetNotificationsHttpError
-   */
-  getNotifications: typeof getNotifications;
-  /**
-   * Clears the cache for notifications api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the notifications api
- */
-declare const notificationsExport: NotificationsAPI;
-//#endregion
-export { NotificationsAPI as a, getNotifications as c, NotificationItem as i, notificationsExport as l, GetNotificationsHttpError as n, NotificationsObject as o, GetNotificationsHttpResponse as r, clearCache as s, Error as t };