@qlik/api 2.2.0 → 2.3.1

package/web-integrations.d.ts

@@ -1,4 +1,295 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { C as getWebIntegration, E as webIntegrationsExport, S as deleteWebIntegration, T as patchWebIntegration, _ as WebIntegrationPostSchema, a as Error, b as clearCache, c as GetWebIntegrationHttpResponse, d as PatchWebIntegrationHttpError, f as PatchWebIntegrationHttpResponse, g as WebIntegrationPost, h as WebIntegrationPatchSchema, i as DeleteWebIntegrationHttpResponse, l as GetWebIntegrationsHttpError, m as WebIntegrationPatch, n as CreateWebIntegrationHttpResponse, o as Errors, p as WebIntegration, r as DeleteWebIntegrationHttpError, s as GetWebIntegrationHttpError, t as CreateWebIntegrationHttpError, u as GetWebIntegrationsHttpResponse, v as WebIntegrations, w as getWebIntegrations, x as createWebIntegration, y as WebIntegrationsAPI } from "./chunks/web-integrations-MisPAHod.js";
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/web-integrations.d.ts
+/**
+ * An error object describing the error.
+ */
+type Error = {
+  /** The error code. */
+  code: string;
+  /** A human-readable explanation specific to this occurrence of the error. */
+  detail?: string;
+  /** Additional properties relating to the error. */
+  meta?: unknown;
+  /** References to the source of the error. */
+  source?: {
+    /** The URI query parameter that caused the error. */
+    parameter?: string;
+    /** A JSON Pointer to the property that caused the error. */
+    pointer?: string;
+  };
+  /** The HTTP status code. */
+  status: string;
+  /** Summary of the problem. */
+  title: string;
+};
+/**
+ * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "TENANTS-8",
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "000000000000000079cf1ebeae103de1"
+ * }
+ */
+type Errors = {
+  /** An array of errors related to the operation. */
+  errors?: Error[];
+  /** A unique identifier for tracing the error. */
+  traceId?: string;
+};
+/**
+ * A web integration object.
+ */
+type WebIntegration = {
+  /** The time the web integration was created. */
+  readonly created?: string;
+  /** The user that created the web integration. */
+  readonly createdBy?: string;
+  /** The unique web integration identifier. */
+  readonly id?: string;
+  /** The time the web integration was last updated. */
+  readonly lastUpdated?: string;
+  /** The name of the web integration. */
+  name?: string;
+  /** The tenant that the web integration belongs to. */
+  tenantId?: string;
+  /** The origins that are allowed to make requests to the tenant. */
+  validOrigins?: string[];
+};
+/**
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
+ */
+type WebIntegrationPatch = {
+  /** The operation to be performed. */
+  op: "replace";
+  /** A JSON Pointer. */
+  path: "/name" | "/validOrigins";
+  /** New value to be used for this operation. */
+  value: string;
+};
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "New name"
+ *   }
+ * ]
+ */
+type WebIntegrationPatchSchema = WebIntegrationPatch[];
+/**
+ * The creation of a web integration response.
+ */
+type WebIntegrationPost = {
+  /** The time the web integration was created. */
+  readonly created?: string;
+  /** The user that created the web integration. */
+  readonly createdBy?: string;
+  /** The unique web integration identifier. */
+  readonly id?: string;
+  /** The time the web integration was last updated. */
+  readonly lastUpdated?: string;
+  /** Pagination links */
+  links?: {
+    /** Link information for current page. */
+    self: {
+      /** URL to the current page of records. */
+      href: string;
+    };
+  };
+  /** The name of the newly created web integration. */
+  name?: string;
+  /** The tenant that the web integration belongs to. */
+  tenantId?: string;
+  /** The origins that are allowed to make requests to the tenant. */
+  validOrigins?: string[];
+};
+type WebIntegrationPostSchema = {
+  /** The name of the web integration to create. */
+  name: string;
+  /** The origins that are allowed to make requests to the tenant. */
+  validOrigins?: string[];
+};
+/**
+ * An array of web integration objects.
+ */
+type WebIntegrations = {
+  /** Properties of web integrations in a given tenant. */
+  data?: WebIntegration[];
+  /** Pagination links */
+  links?: {
+    /** Link information for next page. */
+    next?: {
+      /** URL to the next page of records. */
+      href: string;
+    };
+    /** Link information for previous page. */
+    prev?: {
+      /** URL to the previous page of records. */
+      href: string;
+    };
+    /** Link information for current page. */
+    self: {
+      /** URL to the current page of records. */
+      href: string;
+    };
+  };
+};
+/**
+ * Retrieves web integrations matching the query.
+ *
+ * @param query an object with query parameters
+ * @throws GetWebIntegrationsHttpError
+ */
+declare function getWebIntegrations(query: {
+  /** The target web integration ID to start looking before for web integrations. Cannot be used in conjunction with startingAfter. */
+  endingBefore?: string;
+  /** The number of web integration entries to retrieve. */
+  limit?: number;
+  /** The field to sort by. Prefix with +/- to indicate ascending/descending order. */
+  sort?: "name" | "+name" | "-name";
+  /** The target web integration ID to start looking after for web integrations. Cannot be used in conjunction with endingBefore. */
+  startingAfter?: string;
+  /** The tenant ID to filter by. */
+  tenantId?: string;
+}, options?: ApiCallOptions): Promise<GetWebIntegrationsHttpResponse>;
+type GetWebIntegrationsHttpResponse = {
+  data: WebIntegrations;
+  headers: Headers;
+  status: 200;
+  prev?: (options?: ApiCallOptions) => Promise<GetWebIntegrationsHttpResponse>;
+  next?: (options?: ApiCallOptions) => Promise<GetWebIntegrationsHttpResponse>;
+};
+type GetWebIntegrationsHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Creates a web integration.
+ *
+ * @param body an object with the body content
+ * @throws CreateWebIntegrationHttpError
+ */
+declare function createWebIntegration(body: WebIntegrationPostSchema, options?: ApiCallOptions): Promise<CreateWebIntegrationHttpResponse>;
+type CreateWebIntegrationHttpResponse = {
+  data: WebIntegrationPost;
+  headers: Headers;
+  status: 201;
+};
+type CreateWebIntegrationHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 400 | 403;
+};
+/**
+ * Deletes a single web integration by ID.
+ *
+ * @param id The ID of the web integration to delete.
+ * @throws DeleteWebIntegrationHttpError
+ */
+declare function deleteWebIntegration(id: string, options?: ApiCallOptions): Promise<DeleteWebIntegrationHttpResponse>;
+type DeleteWebIntegrationHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type DeleteWebIntegrationHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 404;
+};
+/**
+ * Retrieves a single web integration by ID.
+ *
+ * @param id The ID of the web integration to retrieve.
+ * @throws GetWebIntegrationHttpError
+ */
+declare function getWebIntegration(id: string, options?: ApiCallOptions): Promise<GetWebIntegrationHttpResponse>;
+type GetWebIntegrationHttpResponse = {
+  data: WebIntegration;
+  headers: Headers;
+  status: 200;
+};
+type GetWebIntegrationHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 404;
+};
+/**
+ * Updates a single web integration by ID.
+ *
+ * @param id The ID of the web integration to update.
+ * @param body an object with the body content
+ * @throws PatchWebIntegrationHttpError
+ */
+declare function patchWebIntegration(id: string, body: WebIntegrationPatchSchema, options?: ApiCallOptions): Promise<PatchWebIntegrationHttpResponse>;
+type PatchWebIntegrationHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type PatchWebIntegrationHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 400 | 404;
+};
+/**
+ * Clears the cache for web-integrations api requests.
+ */
+declare function clearCache(): void;
+type WebIntegrationsAPI = {
+  /**
+   * Retrieves web integrations matching the query.
+   *
+   * @param query an object with query parameters
+   * @throws GetWebIntegrationsHttpError
+   */
+  getWebIntegrations: typeof getWebIntegrations;
+  /**
+   * Creates a web integration.
+   *
+   * @param body an object with the body content
+   * @throws CreateWebIntegrationHttpError
+   */
+  createWebIntegration: typeof createWebIntegration;
+  /**
+   * Deletes a single web integration by ID.
+   *
+   * @param id The ID of the web integration to delete.
+   * @throws DeleteWebIntegrationHttpError
+   */
+  deleteWebIntegration: typeof deleteWebIntegration;
+  /**
+   * Retrieves a single web integration by ID.
+   *
+   * @param id The ID of the web integration to retrieve.
+   * @throws GetWebIntegrationHttpError
+   */
+  getWebIntegration: typeof getWebIntegration;
+  /**
+   * Updates a single web integration by ID.
+   *
+   * @param id The ID of the web integration to update.
+   * @param body an object with the body content
+   * @throws PatchWebIntegrationHttpError
+   */
+  patchWebIntegration: typeof patchWebIntegration;
+  /**
+   * Clears the cache for web-integrations api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the web-integrations api
+ */
+declare const webIntegrationsExport: WebIntegrationsAPI;
+//#endregion
 export { CreateWebIntegrationHttpError, CreateWebIntegrationHttpResponse, DeleteWebIntegrationHttpError, DeleteWebIntegrationHttpResponse, Error, Errors, GetWebIntegrationHttpError, GetWebIntegrationHttpResponse, GetWebIntegrationsHttpError, GetWebIntegrationsHttpResponse, PatchWebIntegrationHttpError, PatchWebIntegrationHttpResponse, WebIntegration, WebIntegrationPatch, WebIntegrationPatchSchema, WebIntegrationPost, WebIntegrationPostSchema, WebIntegrations, WebIntegrationsAPI, clearCache, createWebIntegration, webIntegrationsExport as default, deleteWebIntegration, getWebIntegration, getWebIntegrations, patchWebIntegration };

package/web-integrations.js

@@ -1,6 +1,5 @@
-import "./chunks/utils-BnC4lrlq.js";
-import "./chunks/public-runtime-modules-Dwjzb3l8.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
+import "./chunks/public-runtime-modules-BqxAMJ9M.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
 
 //#region src/public/rest/web-integrations.ts
 /**

package/web-notifications.d.ts

@@ -1,4 +1,274 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { C as deleteNotification, D as patchNotification, E as getNotifications, O as patchNotifications, S as clearCache, T as getNotification, _ as PatchNotificationHttpError, a as Error, b as PatchNotificationsHttpResponse, c as GetNotificationHttpResponse, d as Links, f as Meta, g as Notifications, h as NotificationPatchSchema, i as DeleteNotificationsHttpResponse, k as webNotificationsExport, l as GetNotificationsHttpError, m as NotificationPatch, n as DeleteNotificationHttpResponse, o as Errors, p as Notification, r as DeleteNotificationsHttpError, s as GetNotificationHttpError, t as DeleteNotificationHttpError, u as GetNotificationsHttpResponse, v as PatchNotificationHttpResponse, w as deleteNotifications, x as WebNotificationsAPI, y as PatchNotificationsHttpError } from "./chunks/web-notifications-DVy6FHYh.js";
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/web-notifications.d.ts
+/**
+ * An error object.
+ */
+type Error = {
+  /** The error code. */
+  code: string;
+  /** A human-readable explanation specific to this occurrence of the problem. */
+  message?: string;
+  /** The HTTP status code. */
+  status?: number;
+  /** Summary of the problem. */
+  title: string;
+};
+/**
+ * A representation of the errors encountered from the HTTP request.
+ */
+type Errors = {
+  errors?: Error[];
+};
+/**
+ * Notifications links
+ */
+type Links = {
+  next?: {
+    href?: string;
+  };
+  prev?: {
+    href?: string;
+  };
+  self?: {
+    href?: string;
+  };
+};
+/**
+ * Notifications meta data
+ */
+type Meta = {
+  /** The total number of unread notification. */
+  unreadCount?: number;
+};
+type Notification = {
+  readonly action?: string;
+  readonly body: string;
+  readonly createdAt: string;
+  readonly id: string;
+  meta: unknown;
+  read: boolean;
+  readonly resourceId?: string;
+  resourceType?: string;
+  readonly spaceId?: string;
+  spaceType?: string;
+  subResourceType?: string;
+  readonly tenantId?: string;
+  readonly updatedAt: string;
+  readonly userId: string;
+};
+/**
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
+ */
+type NotificationPatch = {
+  /** The operation to be performed. */
+  op: "replace";
+  /** The path for the given resource field to patch. */
+  path: "/read";
+  /** The value to be used for this operation. */
+  value: string;
+};
+/**
+ * An array of JSON Patch documents
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/read"
+ *   }
+ * ]
+ */
+type NotificationPatchSchema = NotificationPatch[];
+type Notifications = {
+  data?: Notification[];
+  /** Notifications links */
+  links?: Links;
+  /** Notifications meta data */
+  meta?: Meta;
+};
+/**
+ * Retrieve notifications matching the query.
+ * @example
+ * getNotifications(
+ *   {
+ *     resourceType: "app,space"
+ *   }
+ * )
+ *
+ * @param query an object with query parameters
+ * @throws GetNotificationsHttpError
+ */
+declare function getNotifications(query: {
+  /** The number of notification entries to retrieved. */
+  limit?: number;
+  /** Page number */
+  page?: number;
+  /** Read status of the notification */
+  read?: boolean;
+  /** Filter by resource types. If passing more than 1 resource type, use comma seperated string. */
+  resourceType?: string;
+  /** The field to sort by, with +/- prefix indicating sort order */
+  sort?: "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt";
+}, options?: ApiCallOptions): Promise<GetNotificationsHttpResponse>;
+type GetNotificationsHttpResponse = {
+  data: Notifications;
+  headers: Headers;
+  status: 200;
+  prev?: (options?: ApiCallOptions) => Promise<GetNotificationsHttpResponse>;
+  next?: (options?: ApiCallOptions) => Promise<GetNotificationsHttpResponse>;
+};
+type GetNotificationsHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 400 | 401 | 500;
+};
+/**
+ * Delete all notifications.
+ *
+ * @throws DeleteNotificationsHttpError
+ */
+declare function deleteNotifications(options?: ApiCallOptions): Promise<DeleteNotificationsHttpResponse>;
+type DeleteNotificationsHttpResponse = {
+  data: Meta;
+  headers: Headers;
+  status: 204;
+};
+type DeleteNotificationsHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 401 | 500;
+};
+/**
+ * Patch all notifications.
+ *
+ * @param body an object with the body content
+ * @throws PatchNotificationsHttpError
+ */
+declare function patchNotifications(body: NotificationPatchSchema, options?: ApiCallOptions): Promise<PatchNotificationsHttpResponse>;
+type PatchNotificationsHttpResponse = {
+  data: Meta;
+  headers: Headers;
+  status: 204;
+};
+type PatchNotificationsHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 400 | 401 | 500;
+};
+/**
+ * Delete a notification.
+ *
+ * @param notificationId The id of the notification to delete.
+ * @throws DeleteNotificationHttpError
+ */
+declare function deleteNotification(notificationId: string, options?: ApiCallOptions): Promise<DeleteNotificationHttpResponse>;
+type DeleteNotificationHttpResponse = {
+  data: Meta;
+  headers: Headers;
+  status: 204;
+};
+type DeleteNotificationHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 401 | 404 | 500;
+};
+/**
+ * Retrieve a single notification by Id.
+ *
+ * @param notificationId The id of the notification to retrieve.
+ * @throws GetNotificationHttpError
+ */
+declare function getNotification(notificationId: string, options?: ApiCallOptions): Promise<GetNotificationHttpResponse>;
+type GetNotificationHttpResponse = {
+  data: Notification;
+  headers: Headers;
+  status: 200;
+};
+type GetNotificationHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 401 | 404 | 500;
+};
+/**
+ * Patch a notification.
+ *
+ * @param notificationId The id of the notification to update.
+ * @param body an object with the body content
+ * @throws PatchNotificationHttpError
+ */
+declare function patchNotification(notificationId: string, body: NotificationPatchSchema, options?: ApiCallOptions): Promise<PatchNotificationHttpResponse>;
+type PatchNotificationHttpResponse = {
+  data: Meta;
+  headers: Headers;
+  status: 204;
+};
+type PatchNotificationHttpError = {
+  data: Errors;
+  headers: Headers;
+  status: 400 | 401 | 404 | 500;
+};
+/**
+ * Clears the cache for web-notifications api requests.
+ */
+declare function clearCache(): void;
+type WebNotificationsAPI = {
+  /**
+   * Retrieve notifications matching the query.
+   * @example
+   * getNotifications(
+   *   {
+   *     resourceType: "app,space"
+   *   }
+   * )
+   *
+   * @param query an object with query parameters
+   * @throws GetNotificationsHttpError
+   */
+  getNotifications: typeof getNotifications;
+  /**
+   * Delete all notifications.
+   *
+   * @throws DeleteNotificationsHttpError
+   */
+  deleteNotifications: typeof deleteNotifications;
+  /**
+   * Patch all notifications.
+   *
+   * @param body an object with the body content
+   * @throws PatchNotificationsHttpError
+   */
+  patchNotifications: typeof patchNotifications;
+  /**
+   * Delete a notification.
+   *
+   * @param notificationId The id of the notification to delete.
+   * @throws DeleteNotificationHttpError
+   */
+  deleteNotification: typeof deleteNotification;
+  /**
+   * Retrieve a single notification by Id.
+   *
+   * @param notificationId The id of the notification to retrieve.
+   * @throws GetNotificationHttpError
+   */
+  getNotification: typeof getNotification;
+  /**
+   * Patch a notification.
+   *
+   * @param notificationId The id of the notification to update.
+   * @param body an object with the body content
+   * @throws PatchNotificationHttpError
+   */
+  patchNotification: typeof patchNotification;
+  /**
+   * Clears the cache for web-notifications api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the web-notifications api
+ */
+declare const webNotificationsExport: WebNotificationsAPI;
+//#endregion
 export { DeleteNotificationHttpError, DeleteNotificationHttpResponse, DeleteNotificationsHttpError, DeleteNotificationsHttpResponse, Error, Errors, GetNotificationHttpError, GetNotificationHttpResponse, GetNotificationsHttpError, GetNotificationsHttpResponse, Links, Meta, Notification, NotificationPatch, NotificationPatchSchema, Notifications, PatchNotificationHttpError, PatchNotificationHttpResponse, PatchNotificationsHttpError, PatchNotificationsHttpResponse, WebNotificationsAPI, clearCache, webNotificationsExport as default, deleteNotification, deleteNotifications, getNotification, getNotifications, patchNotification, patchNotifications };

package/web-notifications.js

@@ -1,6 +1,5 @@
-import "./chunks/utils-BnC4lrlq.js";
-import "./chunks/public-runtime-modules-Dwjzb3l8.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
+import "./chunks/public-runtime-modules-BqxAMJ9M.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
 
 //#region src/public/rest/web-notifications.ts
 /**