@qlik/api 2.2.0 → 2.3.0

package/data-credentials.d.ts

@@ -1,4 +1,293 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { C as dataCredentialsExport, D as patchDataCredential, E as getDataCredential, O as updateDataCredential, S as clearCache, T as filterOrphanedDataCredentials, _ as PatchDataCredentialHttpResponse, a as DataCredentialsAPI, b as UpdateDataCredentialHttpError, c as Error, d as FilterOrphanedDataCredentialsHttpResponse, f as GetDataCredentialHttpError, g as PatchDataCredentialHttpError, h as OrphanCredentialResItem, i as CredentialCreate, l as Errors, m as Link, n as ActionFilterOrphanResponse, o as DeleteDataCredentialHttpError, p as GetDataCredentialHttpResponse, r as Credential, s as DeleteDataCredentialHttpResponse, t as ActionFilterOrphanRequest, u as FilterOrphanedDataCredentialsHttpError, v as PatchRequest, w as deleteDataCredential, x as UpdateDataCredentialHttpResponse, y as ResponseErrors } from "./chunks/data-credentials-ChEp_hyU.js";
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/data-credentials.d.ts
+type ActionFilterOrphanRequest = {
+  /** Filtering on datasource ID of credentials */
+  datasourceID?: string;
+  /** Filtering on separate status of credentials: * 0 - embedded credential * 1 - separated credential */
+  qSeparated?: 0 | 1;
+  /** Filtering on type of credentials */
+  qType?: string;
+};
+type ActionFilterOrphanResponse = {
+  /** Number of orphan credentials found */
+  count: number;
+  data: OrphanCredentialResItem[];
+};
+type Credential = {
+  /** Datetime when the credential was created */
+  created?: string;
+  /** ID datasource that the credential is created for */
+  datasourceID?: string;
+  links?: Link;
+  /** Number of linked connections */
+  qConnCount: number;
+  /** UUID of the credential */
+  qID: string;
+  /** Name of the credential */
+  qName: string;
+  /** Reference key of credential in redis */
+  qReferenceKey?: string;
+  /** Type of credential */
+  qType: string;
+  /** Datetime when the credential was last updated */
+  updated?: string;
+};
+/**
+ * Credential
+ */
+type CredentialCreate = {
+  /** ID of connection that will be associated with the credential */
+  connectionId?: string;
+  /** ID datasource that the credential is created for */
+  datasourceID?: string;
+  /** UUID of the credential */
+  qID?: string;
+  /** Name of the credential */
+  qName: string;
+  /** Password */
+  qPassword: string;
+  /** Type of credential (i.e. connector provider of the corresponding connection) */
+  qType: string;
+  /** User name */
+  qUsername: string;
+};
+type Error = {
+  /** Unique internal error code */
+  code?: string;
+  /** More concrete details */
+  detail?: string;
+  /** HTTP status code */
+  status?: number;
+  /** A summary in english explaining what went wrong */
+  title?: string;
+};
+type Errors = Error[];
+type Link = {
+  /** Link to current query */
+  self: {
+    /** URL pointing to the resource */
+    href: string;
+  };
+};
+/**
+ * Orphan credential
+ */
+type OrphanCredentialResItem = {
+  /** Datetime when the credential was created */
+  created: string;
+  /** ID datasource that the credential is created for */
+  datasourceID?: string;
+  /** UUID of the credential */
+  qID: string;
+  /** Name of the credential */
+  qName: string;
+  /** Type of credential (i.e. connector provider of the corresponding connection) */
+  qType: string;
+  /** Tenant ID of the credential's owner */
+  tenant?: string;
+  /** Datetime when the credential was last updated */
+  updated: string;
+  /** User ID of the credential's owner */
+  user?: string;
+};
+type PatchRequest = {
+  /** Operation type */
+  op: "add" | "replace" | "remove";
+  /** Path to the target field to be patched */
+  path: string;
+  /** Value used for the patch. Required only for `add` or `replace` operations. The value type should match the type of the target field. */
+  value?: string | boolean | number | unknown[];
+}[];
+type ResponseErrors = {
+  errors?: Errors;
+};
+/**
+ * Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body
+ *
+ * @param body an object with the body content
+ * @throws FilterOrphanedDataCredentialsHttpError
+ */
+declare function filterOrphanedDataCredentials(body: ActionFilterOrphanRequest, options?: ApiCallOptions): Promise<FilterOrphanedDataCredentialsHttpResponse>;
+type FilterOrphanedDataCredentialsHttpResponse = {
+  data: ActionFilterOrphanResponse;
+  headers: Headers;
+  status: 200;
+};
+type FilterOrphanedDataCredentialsHttpError = {
+  data: ResponseErrors;
+  headers: Headers;
+  status: 400 | 403;
+};
+/**
+ * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+ * @example
+ * deleteDataCredential(
+ *   "027d2703-e745-43ec-8876-a2e6ac341700",
+ *   {
+ *     byCredentialName: false
+ *   }
+ * )
+ *
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @throws DeleteDataCredentialHttpError
+ */
+declare function deleteDataCredential(qID: string, query: {
+  /** If set to true, credentialId in the query will be interpreted as credential's name */
+  byCredentialName?: boolean;
+}, options?: ApiCallOptions): Promise<DeleteDataCredentialHttpResponse>;
+type DeleteDataCredentialHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type DeleteDataCredentialHttpError = {
+  data: ResponseErrors;
+  headers: Headers;
+  status: 404;
+};
+/**
+ * Gets a credential by ID (or by name when bycredentialname=true is set in query)
+ * @example
+ * getDataCredential(
+ *   "027d2703-e745-43ec-8876-a2e6ac341700",
+ *   {
+ *     byCredentialName: false
+ *   }
+ * )
+ *
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @throws GetDataCredentialHttpError
+ */
+declare function getDataCredential(qID: string, query: {
+  /** If set to true, credentialId in the query will be interpreted as credential's name */
+  byCredentialName?: boolean;
+}, options?: ApiCallOptions): Promise<GetDataCredentialHttpResponse>;
+type GetDataCredentialHttpResponse = {
+  data: Credential;
+  headers: Headers;
+  status: 200;
+};
+type GetDataCredentialHttpError = {
+  data: ResponseErrors;
+  headers: Headers;
+  status: 400 | 404;
+};
+/**
+ * Patches a credential specified by ID (or by name when bycredentialname=true is set in query)
+ *
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @param body an object with the body content
+ * @throws PatchDataCredentialHttpError
+ */
+declare function patchDataCredential(qID: string, query: {
+  /** If set to true, credentialId in the query will be interpreted as credential's name */
+  byCredentialName?: boolean;
+}, body: PatchRequest, options?: ApiCallOptions): Promise<PatchDataCredentialHttpResponse>;
+type PatchDataCredentialHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type PatchDataCredentialHttpError = {
+  data: ResponseErrors;
+  headers: Headers;
+  status: 400 | 404 | 409;
+};
+/**
+ * Updates a credential specified by ID (or by name when bycredentialname=true is set in query)
+ *
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @param body an object with the body content
+ * @throws UpdateDataCredentialHttpError
+ */
+declare function updateDataCredential(qID: string, query: {
+  /** If set to true, credentialId in the query will be interpreted as credential's name */
+  byCredentialName?: boolean;
+}, body: CredentialCreate, options?: ApiCallOptions): Promise<UpdateDataCredentialHttpResponse>;
+type UpdateDataCredentialHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type UpdateDataCredentialHttpError = {
+  data: ResponseErrors;
+  headers: Headers;
+  status: 400 | 404 | 409;
+};
+/**
+ * Clears the cache for data-credentials api requests.
+ */
+declare function clearCache(): void;
+type DataCredentialsAPI = {
+  /**
+   * Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body
+   *
+   * @param body an object with the body content
+   * @throws FilterOrphanedDataCredentialsHttpError
+   */
+  filterOrphanedDataCredentials: typeof filterOrphanedDataCredentials;
+  /**
+   * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+   * @example
+   * deleteDataCredential(
+   *   "027d2703-e745-43ec-8876-a2e6ac341700",
+   *   {
+   *     byCredentialName: false
+   *   }
+   * )
+   *
+   * @param qID Credential ID
+   * @param query an object with query parameters
+   * @throws DeleteDataCredentialHttpError
+   */
+  deleteDataCredential: typeof deleteDataCredential;
+  /**
+   * Gets a credential by ID (or by name when bycredentialname=true is set in query)
+   * @example
+   * getDataCredential(
+   *   "027d2703-e745-43ec-8876-a2e6ac341700",
+   *   {
+   *     byCredentialName: false
+   *   }
+   * )
+   *
+   * @param qID Credential ID
+   * @param query an object with query parameters
+   * @throws GetDataCredentialHttpError
+   */
+  getDataCredential: typeof getDataCredential;
+  /**
+   * Patches a credential specified by ID (or by name when bycredentialname=true is set in query)
+   *
+   * @param qID Credential ID
+   * @param query an object with query parameters
+   * @param body an object with the body content
+   * @throws PatchDataCredentialHttpError
+   */
+  patchDataCredential: typeof patchDataCredential;
+  /**
+   * Updates a credential specified by ID (or by name when bycredentialname=true is set in query)
+   *
+   * @param qID Credential ID
+   * @param query an object with query parameters
+   * @param body an object with the body content
+   * @throws UpdateDataCredentialHttpError
+   */
+  updateDataCredential: typeof updateDataCredential;
+  /**
+   * Clears the cache for data-credentials api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the data-credentials api
+ */
+declare const dataCredentialsExport: DataCredentialsAPI;
+//#endregion
 export { ActionFilterOrphanRequest, ActionFilterOrphanResponse, Credential, CredentialCreate, DataCredentialsAPI, DeleteDataCredentialHttpError, DeleteDataCredentialHttpResponse, Error, Errors, FilterOrphanedDataCredentialsHttpError, FilterOrphanedDataCredentialsHttpResponse, GetDataCredentialHttpError, GetDataCredentialHttpResponse, Link, OrphanCredentialResItem, PatchDataCredentialHttpError, PatchDataCredentialHttpResponse, PatchRequest, ResponseErrors, UpdateDataCredentialHttpError, UpdateDataCredentialHttpResponse, clearCache, dataCredentialsExport as default, deleteDataCredential, filterOrphanedDataCredentials, getDataCredential, patchDataCredential, updateDataCredential };

package/data-credentials.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-QhLPeQr5.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
 
 //#region src/public/rest/data-credentials.ts
 /**