@qlik/api 1.31.0 → 1.32.0

package/dcaas.d.ts

@@ -0,0 +1,192 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
+
+type ApiSpecResponse = {
+    /** List of properties required for the given datasource */
+    connectionProperties: unknown;
+    /** Datasource provider */
+    connectorProvider: string;
+    /** Datasource provider (i.e. connector) version */
+    connectorVersion: string;
+};
+/**
+ * Response returned when 'authUrlOnly' is set to true in the request body
+ */
+type AuthUrlResponse = {
+    /** Authentication URL for OAuth datasource */
+    authUrl: string;
+};
+type CreateConnectionReq = {
+    /** When set to true, only authentication URL will be returned if datasource supports OAuth (other properties set in the request will ignored). This property will be ignored if the request is not OAuth or datasource doesn't support OAuth */
+    authUrlOnly?: boolean;
+    /** Connection name */
+    connectionName: string;
+    /** List of connection properties required to create dataconnection for a given datasource, which is defined by the response of 'GET /v1/data-datasources/:{datasourceId}/api-specs' */
+    connectionProperties: unknown;
+    /** Datasource ID */
+    dataSourceId: string;
+    /** Target connection space ID */
+    spaceId?: string;
+    /** string tags (32 or less) persisted with the connection object */
+    tags?: string[];
+};
+type CreateConnectionRes = {
+    /** Connection ID */
+    connectionId: string;
+    /** Connection name */
+    connectionName: string;
+    /** Created at time stamp */
+    createdAt: string;
+    /** Credentials ID (if credentials are included in the request) */
+    credentialsId?: string;
+    /** Datasource ID */
+    dataSourceId: string;
+    /** Space ID */
+    spaceId?: string;
+    /** Tenant ID */
+    tenantId: string;
+    /** Updated at time stamp */
+    updateAt: string;
+    /** User ID */
+    userId: string;
+};
+type GetConnectionResponse = {
+    /** Connection ID */
+    connectionId: string;
+    /** Connection name */
+    connectionName: string;
+    /** List of connection properties */
+    connectionProperties: unknown;
+    /** Created at time stamp */
+    createdAt: string;
+    /** Credentials ID (associated with the connection, either embedded or separated) */
+    credentialsId?: string;
+    /** Datasource ID */
+    dataSourceId: string;
+    /** Space ID */
+    spaceId?: string;
+    /** string tags associated with the connection */
+    tags?: string[];
+    /** Tenant ID */
+    tenantId: string;
+    /** Updated at time stamp */
+    updateAt: string;
+    /** User ID */
+    userId: string;
+};
+type PublicApiError = {
+    /** A service specific error code string */
+    code: string;
+    /** Concrete detail about the error */
+    detail?: string;
+    /** Additional metadata associated with the error */
+    meta?: unknown;
+    /** Summary of the error */
+    title: string;
+};
+type ResponseErrors = {
+    errors?: PublicApiError[];
+};
+/**
+ * @deprecated
+ *
+ * DEPRECATED. Use POST /v1/data-connections to create connection.
+ *
+ * @param body an object with the body content
+ * @throws DataConnectionsDcaasHttpError
+ */
+declare const dataConnectionsDcaas: (body: CreateConnectionReq, options?: ApiCallOptions) => Promise<DataConnectionsDcaasHttpResponse>;
+type DataConnectionsDcaasHttpResponse = {
+    data: CreateConnectionRes | AuthUrlResponse;
+    headers: Headers;
+    status: 201;
+};
+type DataConnectionsDcaasHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: 400 | 401 | 403 | 500 | 503;
+};
+/**
+ * @deprecated
+ *
+ * DEPRECATED. Use GET /v1/data-sources/{dataSourceId}/api-specs to return 'connectionProperties' for a given datasource.
+ *
+ * @param query an object with query parameters
+ * @throws DataConnectionsDcaasApiSpecsHttpError
+ */
+declare const dataConnectionsDcaasApiSpecs: (query: {
+    /** Datasource ID */
+    dataSourceId: string;
+}, options?: ApiCallOptions) => Promise<DataConnectionsDcaasApiSpecsHttpResponse>;
+type DataConnectionsDcaasApiSpecsHttpResponse = {
+    data: ApiSpecResponse;
+    headers: Headers;
+    status: 200;
+};
+type DataConnectionsDcaasApiSpecsHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: 401 | 403 | 500 | 503;
+};
+/**
+ * @deprecated
+ *
+ * DEPRECATED. Use GET /v1/data-connections/{connectionId}?parseConnection=true to get connection with parsed connection properties.
+ *
+ * @param connectionId ID of the connection
+ * @throws DataConnectionsDcaaHttpError
+ */
+declare const dataConnectionsDcaa: (connectionId: string, options?: ApiCallOptions) => Promise<DataConnectionsDcaaHttpResponse>;
+type DataConnectionsDcaaHttpResponse = {
+    data: GetConnectionResponse;
+    headers: Headers;
+    status: 200;
+};
+type DataConnectionsDcaaHttpError = {
+    data: ResponseErrors;
+    headers: Headers;
+    status: 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Clears the cache for dcaas api requests.
+ */
+declare function clearCache(): void;
+interface DcaasAPI {
+    /**
+     * @deprecated
+     *
+     * DEPRECATED. Use POST /v1/data-connections to create connection.
+     *
+     * @param body an object with the body content
+     * @throws DataConnectionsDcaasHttpError
+     */
+    dataConnectionsDcaas: typeof dataConnectionsDcaas;
+    /**
+     * @deprecated
+     *
+     * DEPRECATED. Use GET /v1/data-sources/{dataSourceId}/api-specs to return 'connectionProperties' for a given datasource.
+     *
+     * @param query an object with query parameters
+     * @throws DataConnectionsDcaasApiSpecsHttpError
+     */
+    dataConnectionsDcaasApiSpecs: typeof dataConnectionsDcaasApiSpecs;
+    /**
+     * @deprecated
+     *
+     * DEPRECATED. Use GET /v1/data-connections/{connectionId}?parseConnection=true to get connection with parsed connection properties.
+     *
+     * @param connectionId ID of the connection
+     * @throws DataConnectionsDcaaHttpError
+     */
+    dataConnectionsDcaa: typeof dataConnectionsDcaa;
+    /**
+     * Clears the cache for dcaas api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the dcaas api
+ */
+declare const dcaasExport: DcaasAPI;
+
+export { type ApiSpecResponse, type AuthUrlResponse, type CreateConnectionReq, type CreateConnectionRes, type DataConnectionsDcaaHttpError, type DataConnectionsDcaaHttpResponse, type DataConnectionsDcaasApiSpecsHttpError, type DataConnectionsDcaasApiSpecsHttpResponse, type DataConnectionsDcaasHttpError, type DataConnectionsDcaasHttpResponse, type DcaasAPI, type GetConnectionResponse, type PublicApiError, type ResponseErrors, clearCache, dataConnectionsDcaa, dataConnectionsDcaas, dataConnectionsDcaasApiSpecs, dcaasExport as default };

package/dcaas.js

@@ -0,0 +1,39 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/dcaas.ts
+var dataConnectionsDcaas = async (body, options) => invokeFetch("dcaas", {
+  method: "post",
+  pathTemplate: "/api/v1/dcaas/actions/data-connections",
+  body,
+  contentType: "application/json",
+  options
+});
+var dataConnectionsDcaasApiSpecs = async (query, options) => invokeFetch("dcaas", {
+  method: "get",
+  pathTemplate: "/api/v1/dcaas/actions/data-connections/api-specs",
+  query,
+  options
+});
+var dataConnectionsDcaa = async (connectionId, options) => invokeFetch("dcaas", {
+  method: "get",
+  pathTemplate: "/api/v1/dcaas/actions/data-connections/{connectionId}",
+  pathVariables: { connectionId },
+  options
+});
+function clearCache() {
+  return clearApiCache("dcaas");
+}
+var dcaasExport = { dataConnectionsDcaas, dataConnectionsDcaasApiSpecs, dataConnectionsDcaa, clearCache };
+var dcaas_default = dcaasExport;
+export {
+  clearCache,
+  dataConnectionsDcaa,
+  dataConnectionsDcaas,
+  dataConnectionsDcaasApiSpecs,
+  dcaas_default as default
+};