@qlik/api 1.21.0 → 1.23.0

package/tenants.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -62,7 +62,16 @@ type Tenant = {
     status?: "active" | "disabled" | "deleted";
 };
 type TenantCreationRequest = {
-    /** The datacenter where the tenant is located. */
+    /** The datacenter where the tenant is located.
+     *
+     * Supported locations for commercial licenses:
+     * - `ap-northeast-1`: Japan (jp)
+     * - `ap-southeast-1`: Australia (ap)
+     * - `ap-southeast-2`: Singapore (sg)
+     * - `eu-central-1`: Germany (de)
+     * - `eu-west-1`: Ireland (eu)
+     * - `eu-west-2`: United Kingdom (uk)
+     * - `us-east-1`: United States of America (us) */
     datacenter?: string;
     /** The signed license key of the license that will be associated with the created tenant. */
     licenseKey?: string;
@@ -116,7 +125,7 @@ type TenantPatchSchema = {
     value: string | boolean;
 }[];
 /**
- * Creates a Tenant
+ * Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants` if interacting with tenants in the `us` region.
  *
  * @param body an object with the body content
  * @throws CreateTenantHttpError
@@ -149,9 +158,9 @@ type GetMyTenantHttpError = {
     status: number;
 };
 /**
- * Retrieve a single tenant by id.
+ * Retrieves a specific tenant by ID.
  *
- * @param tenantId The id of the tenant to retrieve
+ * @param tenantId The ID of the tenant to retrieve
  * @throws GetTenantHttpError
  */
 declare const getTenant: (tenantId: string, options?: ApiCallOptions) => Promise<GetTenantHttpResponse>;
@@ -166,9 +175,9 @@ type GetTenantHttpError = {
     status: number;
 };
 /**
- * Update a tenant by id.
+ * Updates properties of a specific tenant by ID.
  *
- * @param tenantId The id of the tenant to update
+ * @param tenantId The ID of the tenant to update
  * @param body an object with the body content
  * @throws PatchTenantHttpError
  */
@@ -205,7 +214,7 @@ type PatchTenantDefaultHttpError = {
 };
 type PatchTenantHttpError = PatchTenant400HttpError | PatchTenant403HttpError | PatchTenant404HttpError | PatchTenant429HttpError | PatchTenantDefaultHttpError;
 /**
- * Deactivates a tenant.
+ * Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after `estimatedPurgeDate`. Tenant can be reactivated using `/v1/tenants/{tenantId}/actions/reactivate` until this date. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate` if interacting with tenants in the `us` region.
  *
  * @param tenantId The id of the tenant to deactivate
  * @param body an object with the body content
@@ -223,7 +232,7 @@ type DeactivateTenantHttpError = {
     status: number;
 };
 /**
- * Reactivates a disabled tenant.
+ * Reactivates a deactivated tenant. Tenants can be reactivated until the `estimatedPurgeDate` provided at time of deactivation. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate` if interacting with tenants in the `us` region.
  *
  * @param tenantId The id of the tenant to reactivate
  * @param body an object with the body content
@@ -246,7 +255,7 @@ type ReactivateTenantHttpError = {
 declare function clearCache(): void;
 interface TenantsAPI {
     /**
-     * Creates a Tenant
+     * Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants` if interacting with tenants in the `us` region.
      *
      * @param body an object with the body content
      * @throws CreateTenantHttpError
@@ -259,22 +268,22 @@ interface TenantsAPI {
      */
     getMyTenant: typeof getMyTenant;
     /**
-     * Retrieve a single tenant by id.
+     * Retrieves a specific tenant by ID.
      *
-     * @param tenantId The id of the tenant to retrieve
+     * @param tenantId The ID of the tenant to retrieve
      * @throws GetTenantHttpError
      */
     getTenant: typeof getTenant;
     /**
-     * Update a tenant by id.
+     * Updates properties of a specific tenant by ID.
      *
-     * @param tenantId The id of the tenant to update
+     * @param tenantId The ID of the tenant to update
      * @param body an object with the body content
      * @throws PatchTenantHttpError
      */
     patchTenant: typeof patchTenant;
     /**
-     * Deactivates a tenant.
+     * Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after `estimatedPurgeDate`. Tenant can be reactivated using `/v1/tenants/{tenantId}/actions/reactivate` until this date. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate` if interacting with tenants in the `us` region.
      *
      * @param tenantId The id of the tenant to deactivate
      * @param body an object with the body content
@@ -282,7 +291,7 @@ interface TenantsAPI {
      */
     deactivateTenant: typeof deactivateTenant;
     /**
-     * Reactivates a disabled tenant.
+     * Reactivates a deactivated tenant. Tenants can be reactivated until the `estimatedPurgeDate` provided at time of deactivation. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate` if interacting with tenants in the `us` region.
      *
      * @param tenantId The id of the tenant to reactivate
      * @param body an object with the body content

package/tenants.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/tenants.ts

package/themes.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/themes.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/themes.ts

package/transports.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 type DeleteConfigNotFoundError = {

package/transports.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/transports.ts

package/users.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -135,7 +135,7 @@ type JSONPatch = {
     /** The operation to be performed. */
     op: "replace" | "set (Deprecated)" | "unset (Deprecated)" | "add (Deprecated)" | "renew";
     /** A JSON Pointer. */
-    path: "/name" | "/roles (Deprecated)" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status";
+    path: "/name" | "/roles (Deprecated)" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
     /** The value to be used for this operation. */
     value: string | boolean | unknown[] | AssignedRolesRefIDs | AssignedRolesRefNames;
 };

package/users.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/users.ts

package/web-integrations.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/web-integrations.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/web-integrations.ts

package/web-notifications.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/web-notifications.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/web-notifications.ts

package/webhooks.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 type Delivery = {
@@ -84,7 +84,7 @@ type WebhookBase = {
     readonly disabledReasonCode?: string;
     /** Whether the webhook is active and sending requests */
     enabled?: boolean;
-    /** Types of events for which the webhook should trigger. */
+    /** Types of events for which the webhook should trigger. Retrieve available types from `/v1/webhooks/event-types`. */
     eventTypes?: string[];
     /** Filter that should match for a webhook to be triggered.
      * Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types.
@@ -140,7 +140,7 @@ type WebhookResponse = WebhookBase & {
     readonly origin?: "api" | "automations" | "management-console";
 };
 /**
- * Retrieves all webhooks entries for a tenant
+ * Retrieves all webhooks entries for a tenant that the user has access to. Users assigned the `TenantAdmin` role can retrieve all webhooks. A user can have up to 150 webhooks at one time.
  *
  * @param query an object with query parameters
  * @throws GetWebhooksHttpError
@@ -186,7 +186,7 @@ type GetWebhooksHttpError = {
     status: number;
 };
 /**
- * Creates a new webhook
+ * Creates a new webhook. User must be assigned the `TenantAdmin` role to create `tenant` level webhooks.
  *
  * @param body an object with the body content
  * @throws CreateWebhookHttpError
@@ -203,7 +203,7 @@ type CreateWebhookHttpError = {
     status: number;
 };
 /**
- * List of event-types that are possible to subscribe to.
+ * Lists event-types that are possible to subscribe to.
  *
  * @throws GetWebhookEventTypesHttpError
  */
@@ -219,7 +219,7 @@ type GetWebhookEventTypesHttpError = {
     status: number;
 };
 /**
- * Deletes a specific webhook
+ * Deletes a specific webhook.
  *
  * @param id The webhook's unique identifier.
  * @throws DeleteWebhookHttpError
@@ -236,7 +236,7 @@ type DeleteWebhookHttpError = {
     status: number;
 };
 /**
- * Returns details for a specific webhook
+ * Returns details for a specific webhook.
  *
  * @param id The webhook's unique identifier.
  * @throws GetWebhookHttpError
@@ -253,7 +253,7 @@ type GetWebhookHttpError = {
     status: number;
 };
 /**
- * Patches a webhook
+ * Patches a webhook to update one or more properties.
  *
  * @param id The webhook's unique identifier.
  * @param body an object with the body content
@@ -271,7 +271,7 @@ type PatchWebhookHttpError = {
     status: number;
 };
 /**
- * Updates a webhook
+ * Updates a webhook, any omitted fields will be cleared, returns updated webhook.
  *
  * @param id The webhook's unique identifier.
  * @param body an object with the body content
@@ -289,7 +289,7 @@ type UpdateWebhookHttpError = {
     status: number;
 };
 /**
- * Returns deliveries for a specific webhook
+ * Returns deliveries for a specific webhook. Delivery history is stored for 1 week.
  *
  * @param id The webhook's unique identifier.
  * @param query an object with query parameters
@@ -322,7 +322,7 @@ type GetWebhookDeliveriesHttpError = {
     status: number;
 };
 /**
- * Returns details for a specific delivery
+ * Returns details for a specific delivery.
  *
  * @param id The webhook's unique identifier.
  * @param deliveryId The delivery's unique identifier.
@@ -340,7 +340,7 @@ type GetWebhookDeliveryHttpError = {
     status: number;
 };
 /**
- * Resend the delivery with the same payload
+ * Resends the delivery with the same payload.
  *
  * @param id The webhook's unique identifier.
  * @param deliveryId The delivery's unique identifier.
@@ -363,41 +363,41 @@ type ResendWebhookDeliveryHttpError = {
 declare function clearCache(): void;
 interface WebhooksAPI {
     /**
-     * Retrieves all webhooks entries for a tenant
+     * Retrieves all webhooks entries for a tenant that the user has access to. Users assigned the `TenantAdmin` role can retrieve all webhooks. A user can have up to 150 webhooks at one time.
      *
      * @param query an object with query parameters
      * @throws GetWebhooksHttpError
      */
     getWebhooks: typeof getWebhooks;
     /**
-     * Creates a new webhook
+     * Creates a new webhook. User must be assigned the `TenantAdmin` role to create `tenant` level webhooks.
      *
      * @param body an object with the body content
      * @throws CreateWebhookHttpError
      */
     createWebhook: typeof createWebhook;
     /**
-     * List of event-types that are possible to subscribe to.
+     * Lists event-types that are possible to subscribe to.
      *
      * @throws GetWebhookEventTypesHttpError
      */
     getWebhookEventTypes: typeof getWebhookEventTypes;
     /**
-     * Deletes a specific webhook
+     * Deletes a specific webhook.
      *
      * @param id The webhook's unique identifier.
      * @throws DeleteWebhookHttpError
      */
     deleteWebhook: typeof deleteWebhook;
     /**
-     * Returns details for a specific webhook
+     * Returns details for a specific webhook.
      *
      * @param id The webhook's unique identifier.
      * @throws GetWebhookHttpError
      */
     getWebhook: typeof getWebhook;
     /**
-     * Patches a webhook
+     * Patches a webhook to update one or more properties.
      *
      * @param id The webhook's unique identifier.
      * @param body an object with the body content
@@ -405,7 +405,7 @@ interface WebhooksAPI {
      */
     patchWebhook: typeof patchWebhook;
     /**
-     * Updates a webhook
+     * Updates a webhook, any omitted fields will be cleared, returns updated webhook.
      *
      * @param id The webhook's unique identifier.
      * @param body an object with the body content
@@ -413,7 +413,7 @@ interface WebhooksAPI {
      */
     updateWebhook: typeof updateWebhook;
     /**
-     * Returns deliveries for a specific webhook
+     * Returns deliveries for a specific webhook. Delivery history is stored for 1 week.
      *
      * @param id The webhook's unique identifier.
      * @param query an object with query parameters
@@ -421,7 +421,7 @@ interface WebhooksAPI {
      */
     getWebhookDeliveries: typeof getWebhookDeliveries;
     /**
-     * Returns details for a specific delivery
+     * Returns details for a specific delivery.
      *
      * @param id The webhook's unique identifier.
      * @param deliveryId The delivery's unique identifier.
@@ -429,7 +429,7 @@ interface WebhooksAPI {
      */
     getWebhookDelivery: typeof getWebhookDelivery;
     /**
-     * Resend the delivery with the same payload
+     * Resends the delivery with the same payload.
      *
      * @param id The webhook's unique identifier.
      * @param deliveryId The delivery's unique identifier.

package/webhooks.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/webhooks.ts