@qlik/api 2.4.1 → 2.5.0

package/workflows/automation-connectors.d.ts

@@ -0,0 +1,79 @@
+import { b as ApiCallOptions } from "../chunks/auth-types-DVvka7Hz.js";
+declare namespace automation_connectors_d_exports {
+  export { AutomationConnectorsAPI, AutomationConnectorsList, AutomationConnectorsListObject, Error, ErrorResponse, GetAutomationConnectorsHttpError, GetAutomationConnectorsHttpResponse, Links, PaginationLink, clearCache, automationConnectorsExport as default, getAutomationConnectors };
+}
+type AutomationConnectorsList = {
+  data?: AutomationConnectorsListObject[];
+  links?: Links;
+};
+type AutomationConnectorsListObject = {
+  /** Indicates if the connector is billable. */billable?: boolean; /** Indicates if the connector supports webhooks. */
+  hasWebhooks?: boolean;
+  readonly id?: string; /** The URL to the large logo of the connector. */
+  logoLarge?: string; /** The URL to the medium logo of the connector. */
+  logoMedium?: string; /** The URL to the small logo of the connector. */
+  logoSmall?: string; /** The name of an automation connector. */
+  name?: string;
+};
+type Error = {
+  /** The unique code for the error */code: string; /** May be used to provide additional details */
+  detail?: string; /** A summary of what went wrong */
+  title: string;
+};
+type ErrorResponse = {
+  errors?: Error[]; /** A way to trace the source of the error. */
+  traceId?: string;
+};
+type Links = {
+  next?: PaginationLink;
+  prev?: PaginationLink;
+};
+type PaginationLink = {
+  /** The URL to a resource request */href?: string;
+};
+/**
+ * Retrieves a list of automation connectors.
+ *
+ * @param query an object with query parameters
+ * @throws GetAutomationConnectorsHttpError
+ */
+declare function getAutomationConnectors(query: {
+  /** Filters the result based on the specified criteria: name. */filter?: string; /** The number of automation connectors to retrieve. */
+  limit?: number; /** The field to sort by, with +- prefix indicating sort order. (`?sort=-name` => sort on the `name` field using descending order). */
+  sort?: "id" | "-id" | "+id" | "name" | "+name" | "-name";
+}, options?: ApiCallOptions): Promise<GetAutomationConnectorsHttpResponse>;
+type GetAutomationConnectorsHttpResponse = {
+  data: AutomationConnectorsList;
+  headers: Headers;
+  status: 200;
+  prev?: (options?: ApiCallOptions) => Promise<GetAutomationConnectorsHttpResponse>;
+  next?: (options?: ApiCallOptions) => Promise<GetAutomationConnectorsHttpResponse>;
+};
+type GetAutomationConnectorsHttpError = {
+  data: ErrorResponse;
+  headers: Headers;
+  status: 400 | 401 | 403 | 500 | 503;
+};
+/**
+ * Clears the cache for workflows/automation-connectors api requests.
+ */
+declare function clearCache(): void;
+type AutomationConnectorsAPI = {
+  /**
+   * Retrieves a list of automation connectors.
+   *
+   * @param query an object with query parameters
+   * @throws GetAutomationConnectorsHttpError
+   */
+  getAutomationConnectors: typeof getAutomationConnectors;
+  /**
+   * Clears the cache for automation-connectors api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the automation-connectors api
+ */
+declare const automationConnectorsExport: AutomationConnectorsAPI;
+//#endregion
+export { AutomationConnectorsAPI, AutomationConnectorsList, AutomationConnectorsListObject, Error, ErrorResponse, GetAutomationConnectorsHttpError, GetAutomationConnectorsHttpResponse, Links, PaginationLink, clearCache, automationConnectorsExport as default, getAutomationConnectors, automation_connectors_d_exports as t };

package/workflows/automation-connectors.js

@@ -0,0 +1,40 @@
+import { t as __exportAll } from "../chunks/chunk-BdHzlgOL.js";
+import "../chunks/public-runtime-modules-mBjjPn7I.js";
+import { n as invokeFetch, t as clearApiCache } from "../chunks/invoke-fetch-DxtIsSVQ.js";
+
+//#region src/public/rest/workflows/automation-connectors.ts
+var automation_connectors_exports = /* @__PURE__ */ __exportAll({
+	clearCache: () => clearCache,
+	default: () => automationConnectorsExport,
+	getAutomationConnectors: () => getAutomationConnectors
+});
+/**
+* Retrieves a list of automation connectors.
+*
+* @param query an object with query parameters
+* @throws GetAutomationConnectorsHttpError
+*/
+async function getAutomationConnectors(query, options) {
+	return invokeFetch("workflows/automation-connectors", {
+		method: "get",
+		pathTemplate: "/api/workflows/automation-connectors",
+		query,
+		options
+	});
+}
+/**
+* Clears the cache for workflows/automation-connectors api requests.
+*/
+function clearCache() {
+	return clearApiCache("workflows/automation-connectors");
+}
+/**
+* Functions for the automation-connectors api
+*/
+const automationConnectorsExport = {
+	getAutomationConnectors,
+	clearCache
+};
+
+//#endregion
+export { clearCache, automationConnectorsExport as default, getAutomationConnectors, automation_connectors_exports as t };