@qlik/api 0.0.1

package/data-connections.mjs

@@ -0,0 +1,96 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunk-3YE7EI7I.mjs";
+import "./chunk-WM7FQU2U.mjs";
+
+// src/public/rest/data-connections.ts
+var getDataConnections = async (query, options) => invokeFetch("data-connections", {
+  method: "get",
+  pathTemplate: "/api/v1/data-connections",
+  query,
+  options
+});
+var createDataConnection = async (body, options) => invokeFetch("data-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/data-connections",
+  body,
+  options
+});
+var deleteDataConnections = async (body, options) => invokeFetch("data-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/data-connections/actions/delete",
+  body,
+  options
+});
+var duplicateDataAConnection = async (body, options) => invokeFetch("data-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/data-connections/actions/duplicate",
+  body,
+  options
+});
+var updateDataConnections = async (body, options) => invokeFetch("data-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/data-connections/actions/update",
+  body,
+  options
+});
+var deleteDataConnection = async (qID, query, options) => invokeFetch("data-connections", {
+  method: "delete",
+  pathTemplate: "/api/v1/data-connections/{qID}",
+  pathVariables: { qID },
+  query,
+  options
+});
+var getDataConnection = async (qID, query, options) => invokeFetch("data-connections", {
+  method: "get",
+  pathTemplate: "/api/v1/data-connections/{qID}",
+  pathVariables: { qID },
+  query,
+  options
+});
+var patchDataConnection = async (qID, query, body, options) => invokeFetch("data-connections", {
+  method: "patch",
+  pathTemplate: "/api/v1/data-connections/{qID}",
+  pathVariables: { qID },
+  query,
+  body,
+  options
+});
+var updateDataConnection = async (qID, query, body, options) => invokeFetch("data-connections", {
+  method: "put",
+  pathTemplate: "/api/v1/data-connections/{qID}",
+  pathVariables: { qID },
+  query,
+  body,
+  options
+});
+function clearCache() {
+  return clearApiCache("data-connections");
+}
+var dataConnectionsExport = {
+  getDataConnections,
+  createDataConnection,
+  deleteDataConnections,
+  duplicateDataAConnection,
+  updateDataConnections,
+  deleteDataConnection,
+  getDataConnection,
+  patchDataConnection,
+  updateDataConnection,
+  clearCache
+};
+var data_connections_default = dataConnectionsExport;
+export {
+  clearCache,
+  createDataConnection,
+  data_connections_default as default,
+  deleteDataConnection,
+  deleteDataConnections,
+  duplicateDataAConnection,
+  getDataConnection,
+  getDataConnections,
+  patchDataConnection,
+  updateDataConnection,
+  updateDataConnections
+};

package/data-credentials.d.mts

@@ -0,0 +1,188 @@
+import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
+import './auth-types-nnUcWhuU.mjs';
+
+type Credential = {
+    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;
+};
+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;
+    /** UName of the credential */
+    qName: string;
+    /** Password */
+    qPassword: string;
+    /** Type of credential */
+    qType: string;
+    /** User name */
+    qUsername: string;
+};
+type Error = {
+    /** Unique internal error code */
+    code?: string;
+    /** More concrete details */
+    detail?: string;
+    /** A summary in english explaining what went wrong */
+    title?: string;
+};
+type Errors = Error[];
+type Link = {
+    /** Link to cirrent query */
+    self: {
+        href: string;
+    };
+};
+type PatchRequest = {
+    patchData: {
+        /** Operation type */
+        op?: "add" | "replace" | "remove";
+        /** Path to the target field to be patched */
+        path?: string;
+        /** The value used for the patch, only needed for 'add' or 'replace'. Value type could be either string or integer, should match with the type of the target field */
+        value?: string;
+    }[];
+};
+type ResponseErrors = {
+    errors?: Errors;
+};
+/**
+ * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @throws DeleteDataCredentialHttpError
+ */
+declare const deleteDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, options?: ApiCallOptions) => Promise<DeleteDataCredentialHttpResponse>;
+type DeleteDataCredentialHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type DeleteDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Gets a credential by ID (or by name when bycredentialname=true is set in query)
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @throws GetDataCredentialHttpError
+ */
+declare const getDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, options?: ApiCallOptions) => Promise<GetDataCredentialHttpResponse>;
+type GetDataCredentialHttpResponse = {
+    data: Credential;
+    headers: Headers;
+    status: number;
+};
+type GetDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * 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 const patchDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, body: PatchRequest, options?: ApiCallOptions) => Promise<PatchDataCredentialHttpResponse>;
+type PatchDataCredentialHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type PatchDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * 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 const updateDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, body: CredentialCreate, options?: ApiCallOptions) => Promise<UpdateDataCredentialHttpResponse>;
+type UpdateDataCredentialHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type UpdateDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for data-credentials api requests.
+ */
+declare function clearCache(): void;
+interface DataCredentialsAPI {
+    /**
+     * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+     * @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)
+     * @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;
+
+export { type Credential, type CredentialCreate, type DataCredentialsAPI, type DeleteDataCredentialHttpError, type DeleteDataCredentialHttpResponse, type Error, type Errors, type GetDataCredentialHttpError, type GetDataCredentialHttpResponse, type Link, type PatchDataCredentialHttpError, type PatchDataCredentialHttpResponse, type PatchRequest, type ResponseErrors, type UpdateDataCredentialHttpError, type UpdateDataCredentialHttpResponse, clearCache, dataCredentialsExport as default, deleteDataCredential, getDataCredential, patchDataCredential, updateDataCredential };

package/data-credentials.d.ts

@@ -0,0 +1,188 @@
+import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
+import './auth-types-nnUcWhuU.js';
+
+type Credential = {
+    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;
+};
+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;
+    /** UName of the credential */
+    qName: string;
+    /** Password */
+    qPassword: string;
+    /** Type of credential */
+    qType: string;
+    /** User name */
+    qUsername: string;
+};
+type Error = {
+    /** Unique internal error code */
+    code?: string;
+    /** More concrete details */
+    detail?: string;
+    /** A summary in english explaining what went wrong */
+    title?: string;
+};
+type Errors = Error[];
+type Link = {
+    /** Link to cirrent query */
+    self: {
+        href: string;
+    };
+};
+type PatchRequest = {
+    patchData: {
+        /** Operation type */
+        op?: "add" | "replace" | "remove";
+        /** Path to the target field to be patched */
+        path?: string;
+        /** The value used for the patch, only needed for 'add' or 'replace'. Value type could be either string or integer, should match with the type of the target field */
+        value?: string;
+    }[];
+};
+type ResponseErrors = {
+    errors?: Errors;
+};
+/**
+ * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @throws DeleteDataCredentialHttpError
+ */
+declare const deleteDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, options?: ApiCallOptions) => Promise<DeleteDataCredentialHttpResponse>;
+type DeleteDataCredentialHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type DeleteDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Gets a credential by ID (or by name when bycredentialname=true is set in query)
+ * @param qID Credential ID
+ * @param query an object with query parameters
+ * @throws GetDataCredentialHttpError
+ */
+declare const getDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, options?: ApiCallOptions) => Promise<GetDataCredentialHttpResponse>;
+type GetDataCredentialHttpResponse = {
+    data: Credential;
+    headers: Headers;
+    status: number;
+};
+type GetDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * 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 const patchDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, body: PatchRequest, options?: ApiCallOptions) => Promise<PatchDataCredentialHttpResponse>;
+type PatchDataCredentialHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type PatchDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * 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 const updateDataCredential: (qID: string, query: {
+    /** If set to true, credentialId in the query will be intepreted as credential's name */
+    byCredentialName?: boolean;
+}, body: CredentialCreate, options?: ApiCallOptions) => Promise<UpdateDataCredentialHttpResponse>;
+type UpdateDataCredentialHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type UpdateDataCredentialHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for data-credentials api requests.
+ */
+declare function clearCache(): void;
+interface DataCredentialsAPI {
+    /**
+     * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+     * @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)
+     * @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;
+
+export { type Credential, type CredentialCreate, type DataCredentialsAPI, type DeleteDataCredentialHttpError, type DeleteDataCredentialHttpResponse, type Error, type Errors, type GetDataCredentialHttpError, type GetDataCredentialHttpResponse, type Link, type PatchDataCredentialHttpError, type PatchDataCredentialHttpResponse, type PatchRequest, type ResponseErrors, type UpdateDataCredentialHttpError, type UpdateDataCredentialHttpResponse, clearCache, dataCredentialsExport as default, deleteDataCredential, getDataCredential, patchDataCredential, updateDataCredential };

package/data-credentials.js

@@ -0,0 +1,56 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
+require('./chunk-ZT4C7KCQ.js');
+
+// src/public/rest/data-credentials.ts
+var deleteDataCredential = async (qID, query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-credentials", {
+  method: "delete",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  options
+});
+var getDataCredential = async (qID, query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-credentials", {
+  method: "get",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  options
+});
+var patchDataCredential = async (qID, query, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-credentials", {
+  method: "patch",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  body,
+  options
+});
+var updateDataCredential = async (qID, query, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-credentials", {
+  method: "put",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  body,
+  options
+});
+function clearCache() {
+  return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "data-credentials");
+}
+var dataCredentialsExport = {
+  deleteDataCredential,
+  getDataCredential,
+  patchDataCredential,
+  updateDataCredential,
+  clearCache
+};
+var data_credentials_default = dataCredentialsExport;
+
+
+
+
+
+
+
+exports.clearCache = clearCache; exports.default = data_credentials_default; exports.deleteDataCredential = deleteDataCredential; exports.getDataCredential = getDataCredential; exports.patchDataCredential = patchDataCredential; exports.updateDataCredential = updateDataCredential;

package/data-credentials.mjs

@@ -0,0 +1,56 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunk-3YE7EI7I.mjs";
+import "./chunk-WM7FQU2U.mjs";
+
+// src/public/rest/data-credentials.ts
+var deleteDataCredential = async (qID, query, options) => invokeFetch("data-credentials", {
+  method: "delete",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  options
+});
+var getDataCredential = async (qID, query, options) => invokeFetch("data-credentials", {
+  method: "get",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  options
+});
+var patchDataCredential = async (qID, query, body, options) => invokeFetch("data-credentials", {
+  method: "patch",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  body,
+  options
+});
+var updateDataCredential = async (qID, query, body, options) => invokeFetch("data-credentials", {
+  method: "put",
+  pathTemplate: "/api/v1/data-credentials/{qID}",
+  pathVariables: { qID },
+  query,
+  body,
+  options
+});
+function clearCache() {
+  return clearApiCache("data-credentials");
+}
+var dataCredentialsExport = {
+  deleteDataCredential,
+  getDataCredential,
+  patchDataCredential,
+  updateDataCredential,
+  clearCache
+};
+var data_credentials_default = dataCredentialsExport;
+export {
+  clearCache,
+  data_credentials_default as default,
+  deleteDataCredential,
+  getDataCredential,
+  patchDataCredential,
+  updateDataCredential
+};