feat: qlik api updates

qlik-oss · Oct 3, 2024 · 0e33d2f · 0e33d2f
1 parent b52b748
commit 0e33d2f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 25 deletions.
diff --git a/reloads.d.ts b/reloads.d.ts
@@ -43,7 +43,7 @@ type Reload = {
     status: Status;
     /** The ID of the tenant who owns the reload. */
     tenantId: string;
-    /** What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data. */
+    /** What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer. */
     type: Type;
     /** The ID of the user who created the reload. */
     userId: string;
@@ -70,9 +70,9 @@ type ReloadsLinks = ReloadLinks & {
  */
 type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "EXCEEDED_LIMIT";
 /**
- * What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data.
+ * What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer.
  */
-type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh";
+type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh" | "choreographer";
 /**
  * Finds and returns the reloads that the user has access to.
  *

diff --git a/reports.d.ts b/reports.d.ts
@@ -146,7 +146,7 @@ type ImageOutput = {
  * Define the request metadata. It includes priority, deadline and future settings on execution policy of the request.
  */
 type Meta = {
-    /** The maximum interval, starting from the time the API request is received, within which a report must be produced, past this interval the report generation fails. The default value is 10 minutes, the maximum allowed value is 2 hours. */
+    /** The maximum interval, starting from the time the API request is received, within which a report must be produced, past this interval the report generation fails. The default value is 10 minutes, the maximum allowed value is 4 hours. */
     exportDeadline?: string;
     /** Time to live of the final result artifacts in ISO8601 duration format. After that duration the request and underlying output files will not be guaranteed to be available. Default is 1 hour. */
     outputTtl?: string;

diff --git a/webhooks.d.ts b/webhooks.d.ts
@@ -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,73 +363,73 @@ 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
      * @throws PatchWebhookHttpError
      */
     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
      * @throws UpdateWebhookHttpError
      */
     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
      * @throws GetWebhookDeliveriesHttpError
      */
     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.
      * @throws GetWebhookDeliveryHttpError
      */
     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.