@qlik/api 2.2.0 → 2.3.0

package/chunks/consumption-DerFk437.d.ts

@@ -1,182 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/consumption.d.ts
-type Enforcement = {
-  /** Resource action type to be blocked */
-  actionToBlock?: string;
-  /** Resource type to be blocked */
-  resourceType?: string;
-};
-/**
- * @example
- * {
- *   errors: [
- *     {
- *       code: "HTTP-123",
- *       title: "short error message"
- *     }
- *   ],
- *   traceId: "7975401f3954aa47"
- * }
- */
-type ErrorResponse = {
-  errors?: SingleErrorResponse[];
-  traceId?: string;
-};
-type ExecutionResponse = {
-  blocked?: boolean;
-  /** RFC3339 timestamp when a block event was last emitted for this execution. */
-  blockedEventTime?: string;
-  /** The capacity limit. */
-  capacityLimit?: number;
-  closeToOverage?: boolean;
-  /** The id of the consumption report */
-  consumptionReportId?: string;
-  /** The field to determine if a resource should be visible on the client. */
-  customerFacing?: boolean;
-  /** Contains a list of resources that are blocked when quota for this is reached. */
-  enforcement?: Enforcement[];
-  /** The global usage. */
-  globalUsage?: number;
-  /** The guardrail limit. */
-  guardrailLimit?: number;
-  /** The local usage. */
-  localUsage?: number;
-  overage?: boolean;
-  /** RFC3339 timestamp when a overage event was last emitted for this execution. */
-  overageEventTime?: string;
-  /** The end of the associated period. */
-  periodEnd?: string;
-  /** The start of the associated period. */
-  periodStart?: string;
-  periodType?: "day" | "month" | "year" | "" | "fixed" | "minute";
-  /** The resource action. */
-  resourceAction?: "report.generated" | "reload" | "scheduledReload" | "executed" | "aggregation" | "import" | "updated" | "deployed" | "3rd_party_executed" | "standard_executed";
-  /** The resource id. */
-  resourceId?: string;
-  /** The resource type. */
-  resourceType?: "app" | "automations" | "space" | "data.volume.consumption";
-  scope?: ("user" | "tenant" | "resourceId" | "resourceType" | "resourceAction")[];
-  /** The map to the resource scope. */
-  scopeMapping?: string;
-  segments?: Record<string, unknown>[];
-  /** The resource task description. */
-  taskDescription?: string;
-  /** The resource task name. */
-  taskName?: string;
-  /** The tenant id. */
-  tenantId?: string;
-  /** Unit of measurement for the resource consumption */
-  unit?: string;
-  /** The RFC3339 timestamp when the resource was updated. */
-  updateTime?: string;
-  /** The user id. */
-  userId?: string;
-};
-type ExecutionsByTenantList = StandardListResponseProps & {
-  closeToOverage?: boolean;
-  data?: ExecutionResponse[];
-  globalUsageAvailable?: boolean;
-  links?: ListLinks;
-  overage?: boolean;
-};
-type ListLinks = {
-  next?: Page;
-  prev?: Page;
-  /** Object with Href to a particular element or set of elements */
-  self?: Self;
-};
-type Page = {
-  /** URL to particular set of elements */
-  href?: string;
-  /** Page unique token */
-  token?: string;
-  /** Page type, can be next or prev */
-  type?: "prev" | "next";
-};
-/**
- * Object with Href to a particular element or set of elements
- */
-type Self = {
-  href?: string;
-};
-type SingleErrorResponse = {
-  /** Error code specific to usage-tracker. */
-  readonly code?: string;
-  /** Error cause. */
-  readonly detail?: string;
-  /** meta properties for an error. */
-  meta?: unknown;
-  /** Error title. */
-  readonly title?: string;
-};
-/**
- * properties that should be added to every list response
- */
-type StandardListResponseProps = {
-  /** count of entries on the currently shown page */
-  currentPageCount: number;
-  /** total count of entries in the collection as a whole */
-  totalCount: number;
-};
-/**
- * Retrieves the list of executions on an specific tenant
- *
- * @param query an object with query parameters
- * @throws GetConsumptionExecutionsHttpError
- */
-declare function getConsumptionExecutions(query: {
-  actionToBlock?: string;
-  /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax.
-   *
-   * example `taskName eq "automation_run_ended" or taskName eq "report_triggered" or or taskName eq "dataVolumeAggregated"`
-   *
-   * The following fields are supported: `scope`, `resourcetype`, `resourceaction`, `resourceid`, `capacitylimit`,
-   * `localusage`, `globalusage`, `overage`, `blocked`, `periodstart`, `periodend`, `consumptionreportid`, `blockedeventtime`,
-   * `overageeventtime`, `taskname`, `taskdescription`, `userid`, `tenantid`, `customerfacing`, `actiontoblock` */
-  filter?: string;
-  /** Limit the returned result set */
-  limit?: number;
-  /** Offset for pagination - how many elements to skip */
-  offset?: number;
-  /** The cursor to the page of data. */
-  page?: string;
-  /** Specifies which periods to include regardless of the period type, start and end specified */
-  periodsToInclude?: ("current" | "previous")[];
-  sort?: ("periodstart" | "-periodstart" | "+periodstart" | "periodend" | "-periodend" | "+periodend")[];
-}, options?: ApiCallOptions): Promise<GetConsumptionExecutionsHttpResponse>;
-type GetConsumptionExecutionsHttpResponse = {
-  data: ExecutionsByTenantList;
-  headers: Headers;
-  status: 200;
-  prev?: (options?: ApiCallOptions) => Promise<GetConsumptionExecutionsHttpResponse>;
-  next?: (options?: ApiCallOptions) => Promise<GetConsumptionExecutionsHttpResponse>;
-};
-type GetConsumptionExecutionsHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: number;
-};
-/**
- * Clears the cache for consumption api requests.
- */
-declare function clearCache(): void;
-type ConsumptionAPI = {
-  /**
-   * Retrieves the list of executions on an specific tenant
-   *
-   * @param query an object with query parameters
-   * @throws GetConsumptionExecutionsHttpError
-   */
-  getConsumptionExecutions: typeof getConsumptionExecutions;
-  /**
-   * Clears the cache for consumption api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the consumption api
- */
-declare const consumptionExport: ConsumptionAPI;
-//#endregion
-export { ExecutionsByTenantList as a, ListLinks as c, SingleErrorResponse as d, StandardListResponseProps as f, getConsumptionExecutions as h, ExecutionResponse as i, Page as l, consumptionExport as m, Enforcement as n, GetConsumptionExecutionsHttpError as o, clearCache as p, ErrorResponse as r, GetConsumptionExecutionsHttpResponse as s, ConsumptionAPI as t, Self as u };

package/chunks/core-DQXNZdnf.d.ts

@@ -1,12 +0,0 @@
-import { D as ipPoliciesExport } from "./ip-policies-CKRIlbP7.js";
-
-//#region src/public/rest/core.d.ts
-type CoreAPI = {};
-/**
- * Functions for the core api
- */
-declare const coreExport: CoreAPI & {
-  ipPolicies: typeof ipPoliciesExport;
-};
-//#endregion
-export { coreExport as n, CoreAPI as t };

package/chunks/csp-origins-3NJlh_n9.d.ts

@@ -1,273 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/csp-origins.d.ts
-type CSPEntry = {
-  /** The CSP entry's unique identifier. */
-  id?: string;
-} & CSPEntryContent;
-type CSPEntryContent = {
-  /** Defines the valid sources for loading web workers and nested browsing contexts using elements such as frame and iFrame. */
-  childSrc?: boolean;
-  /** Restricts the URLs that can be loaded using script interfaces. */
-  connectSrc?: boolean;
-  /** Restricts the URLs that can be connected to websockets (all sources will be prefixed with 'wss://'). */
-  connectSrcWSS?: boolean;
-  /** The UTC timestamp when the CSP entry was created. */
-  readonly createdDate?: string;
-  /** The reason for adding this origin to the Content Security Policy. */
-  description?: string;
-  /** Specifies valid sources for loading fonts. */
-  fontSrc?: boolean;
-  /** Allow forms to be submitted to the origin. */
-  formAction?: boolean;
-  /** Specifies valid sources for embedding the resource using frame, iFrame, object, embed and applet. */
-  frameAncestors?: boolean;
-  /** Specifies valid sources for loading nested browsing contexts using elements such as frame and iFrame. */
-  frameSrc?: boolean;
-  /** Specifies valid sources of images and favicons. */
-  imgSrc?: boolean;
-  /** Specifies valid sources for loading media using the audio and video elements. */
-  mediaSrc?: boolean;
-  /** The UTC timestamp when the CSP entry was last modified. */
-  readonly modifiedDate?: string;
-  /** The name for this entry. */
-  name?: string;
-  /** Specifies valid sources for the object, embed, and applet elements. */
-  objectSrc?: boolean;
-  /** The origin that the CSP directives should be applied to. */
-  origin: string;
-  /** Specifies valid sources for JavaScript. */
-  scriptSrc?: boolean;
-  /** Specifies valid sources for stylesheets. */
-  styleSrc?: boolean;
-  /** Specifies valid sources for Worker, SharedWorker, or ServiceWorker scripts. */
-  workerSrc?: boolean;
-};
-type CSPEntryList = {
-  data?: CSPEntry[];
-  links?: {
-    next?: Link;
-    prev?: Link;
-    self?: Link;
-  };
-};
-type CSPHeader = {
-  /** The compiled CSP header. */
-  "Content-Security-Policy"?: 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[];
-};
-type Link = {
-  /** URL to a resource request. */
-  href: string;
-};
-/**
- * Retrieves all content security policies for a tenant.
- *
- * @param query an object with query parameters
- * @throws GetCSPEntriesHttpError
- */
-declare function getCSPEntries(query: {
-  /** Filter resources by directive 'childSrc', true/false. */
-  childSrc?: boolean;
-  /** Filter resources by directive 'connectSrc', true/false. */
-  connectSrc?: boolean;
-  /** Filter resources by directive 'connectSrcWSS', true/false. */
-  connectSrcWSS?: boolean;
-  /** Filter resources by directive 'fontSrc', true/false. */
-  fontSrc?: boolean;
-  /** Filter resources by directive 'formAction', true/false. */
-  formAction?: boolean;
-  /** Filter resources by directive 'frameAncestors', true/false. */
-  frameAncestors?: boolean;
-  /** Filter resources by directive 'frameSrc', true/false. */
-  frameSrc?: boolean;
-  /** Filter resources by directive 'imgSrc', true/false. */
-  imgSrc?: boolean;
-  /** Maximum number of CSP-Origins to retrieve. */
-  limit?: number;
-  /** Filter resources by directive 'mediaSrc', true/false. */
-  mediaSrc?: boolean;
-  /** Filter resources by name (wildcard and case insensitive). */
-  name?: string;
-  /** Cursor to the next page. */
-  next?: string;
-  /** Filter resources by directive 'objectSrc', true/false. */
-  objectSrc?: boolean;
-  /** Filter resources by origin (wildcard and case insensitive). */
-  origin?: string;
-  /** Cursor to previous next page. */
-  prev?: string;
-  /** Filter resources by directive 'scriptSrc', true/false. */
-  scriptSrc?: boolean;
-  /** Field to sort by, prefix with -/+ to indicate order. */
-  sort?: "name" | "-name" | "origin" | "-origin" | "createdDate" | "-createdDate" | "modifiedDate" | "-modifiedDate";
-  /** Filter resources by directive 'styleSrc', true/false. */
-  styleSrc?: boolean;
-  /** Filter resources by directive 'workerSrc', true/false. */
-  workerSrc?: boolean;
-}, options?: ApiCallOptions): Promise<GetCSPEntriesHttpResponse>;
-type GetCSPEntriesHttpResponse = {
-  data: CSPEntryList;
-  headers: Headers;
-  status: 200;
-  prev?: (options?: ApiCallOptions) => Promise<GetCSPEntriesHttpResponse>;
-  next?: (options?: ApiCallOptions) => Promise<GetCSPEntriesHttpResponse>;
-};
-type GetCSPEntriesHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 500 | 503;
-};
-/**
- * Creates a new content security policy for an origin.
- *
- * @param body an object with the body content
- * @throws CreateCSPEntryHttpError
- */
-declare function createCSPEntry(body: CSPEntryContent, options?: ApiCallOptions): Promise<CreateCSPEntryHttpResponse>;
-type CreateCSPEntryHttpResponse = {
-  data: CSPEntry;
-  headers: Headers;
-  status: 201;
-};
-type CreateCSPEntryHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 500 | 503;
-};
-/**
- * Retrieves the full content security policy header (including all configured policies and origins) for the tenant.
- *
- * @throws GetCSPHeaderHttpError
- */
-declare function getCSPHeader(options?: ApiCallOptions): Promise<GetCSPHeaderHttpResponse>;
-type GetCSPHeaderHttpResponse = {
-  data: CSPHeader;
-  headers: Headers;
-  status: 200;
-};
-type GetCSPHeaderHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 401 | 406 | 500 | 503;
-};
-/**
- * Deletes a specific content security policy.
- *
- * @param id The CSP entry's unique identifier.
- * @throws DeleteCSPEntryHttpError
- */
-declare function deleteCSPEntry(id: string, options?: ApiCallOptions): Promise<DeleteCSPEntryHttpResponse>;
-type DeleteCSPEntryHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type DeleteCSPEntryHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 500 | 503;
-};
-/**
- * Returns details for a specific content security policy.
- *
- * @param id The CSP entry's unique identifier.
- * @throws GetCSPEntryHttpError
- */
-declare function getCSPEntry(id: string, options?: ApiCallOptions): Promise<GetCSPEntryHttpResponse>;
-type GetCSPEntryHttpResponse = {
-  data: CSPEntry;
-  headers: Headers;
-  status: 200;
-};
-type GetCSPEntryHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 500 | 503;
-};
-/**
- * Updates a content security policy.
- *
- * @param id The CSP entry's unique identifier.
- * @param body an object with the body content
- * @throws UpdateCSPEntryHttpError
- */
-declare function updateCSPEntry(id: string, body: CSPEntryContent, options?: ApiCallOptions): Promise<UpdateCSPEntryHttpResponse>;
-type UpdateCSPEntryHttpResponse = {
-  data: CSPEntry;
-  headers: Headers;
-  status: 200;
-};
-type UpdateCSPEntryHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 500 | 503;
-};
-/**
- * Clears the cache for csp-origins api requests.
- */
-declare function clearCache(): void;
-type CspOriginsAPI = {
-  /**
-   * Retrieves all content security policies for a tenant.
-   *
-   * @param query an object with query parameters
-   * @throws GetCSPEntriesHttpError
-   */
-  getCSPEntries: typeof getCSPEntries;
-  /**
-   * Creates a new content security policy for an origin.
-   *
-   * @param body an object with the body content
-   * @throws CreateCSPEntryHttpError
-   */
-  createCSPEntry: typeof createCSPEntry;
-  /**
-   * Retrieves the full content security policy header (including all configured policies and origins) for the tenant.
-   *
-   * @throws GetCSPHeaderHttpError
-   */
-  getCSPHeader: typeof getCSPHeader;
-  /**
-   * Deletes a specific content security policy.
-   *
-   * @param id The CSP entry's unique identifier.
-   * @throws DeleteCSPEntryHttpError
-   */
-  deleteCSPEntry: typeof deleteCSPEntry;
-  /**
-   * Returns details for a specific content security policy.
-   *
-   * @param id The CSP entry's unique identifier.
-   * @throws GetCSPEntryHttpError
-   */
-  getCSPEntry: typeof getCSPEntry;
-  /**
-   * Updates a content security policy.
-   *
-   * @param id The CSP entry's unique identifier.
-   * @param body an object with the body content
-   * @throws UpdateCSPEntryHttpError
-   */
-  updateCSPEntry: typeof updateCSPEntry;
-  /**
-   * Clears the cache for csp-origins api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the csp-origins api
- */
-declare const cspOriginsExport: CspOriginsAPI;
-//#endregion
-export { cspOriginsExport as C, getCSPHeader as D, getCSPEntry as E, updateCSPEntry as O, createCSPEntry as S, getCSPEntries as T, GetCSPHeaderHttpResponse as _, CreateCSPEntryHttpError as a, UpdateCSPEntryHttpResponse as b, DeleteCSPEntryHttpError as c, ErrorResponse as d, GetCSPEntriesHttpError as f, GetCSPHeaderHttpError as g, GetCSPEntryHttpResponse as h, CSPHeader as i, DeleteCSPEntryHttpResponse as l, GetCSPEntryHttpError as m, CSPEntryContent as n, CreateCSPEntryHttpResponse as o, GetCSPEntriesHttpResponse as p, CSPEntryList as r, CspOriginsAPI as s, CSPEntry as t, Error as u, Link as v, deleteCSPEntry as w, clearCache as x, UpdateCSPEntryHttpError as y };

package/chunks/csrf-token-DoaoOQzH.d.ts

@@ -1,63 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/csrf-token.d.ts
-
-/**
- * An error object.
- */
-type Error = {
-  /** The error code. */
-  code: string;
-  /** The detailed error message */
-  detail?: string;
-  /** Non-standard information about the error */
-  meta?: unknown;
-  /** The http status code. */
-  status?: string;
-  /** The error title. */
-  title: string;
-};
-/**
- * A representation of the errors encountered from the HTTP request.
- */
-type Errors = {
-  errors?: Error[];
-};
-/**
- * Returns CSRF token via the qlik-csrf-token header.
- *
- * @throws GetCsrfTokenHttpError
- */
-declare function getCsrfToken(options?: ApiCallOptions): Promise<GetCsrfTokenHttpResponse>;
-type GetCsrfTokenHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type GetCsrfTokenHttpError = {
-  data: Errors & unknown;
-  headers: Headers;
-  status: 400 | 404;
-};
-/**
- * Clears the cache for csrf-token api requests.
- */
-declare function clearCache(): void;
-type CsrfTokenAPI = {
-  /**
-   * Returns CSRF token via the qlik-csrf-token header.
-   *
-   * @throws GetCsrfTokenHttpError
-   */
-  getCsrfToken: typeof getCsrfToken;
-  /**
-   * Clears the cache for csrf-token api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the csrf-token api
- */
-declare const csrfTokenExport: CsrfTokenAPI;
-//#endregion
-export { GetCsrfTokenHttpResponse as a, getCsrfToken as c, GetCsrfTokenHttpError as i, Error as n, clearCache as o, Errors as r, csrfTokenExport as s, CsrfTokenAPI as t };