@qlik/api 2.3.1 → 2.4.0

package/sharing-tasks.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-BqxAMJ9M.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/sharing-tasks.ts
 /**
@@ -232,7 +232,6 @@ const sharingTasksExport = {
 	getSharingTaskExecutionFile,
 	clearCache
 };
-var sharing_tasks_default = sharingTasksExport;
 
 //#endregion
-export { cancelSharingTask, clearCache, configureSharingTasksSettings, createSharingTask, sharing_tasks_default as default, deleteSharingTask, executeSharingTasks, getSharingTask, getSharingTaskExecution, getSharingTaskExecutionFile, getSharingTaskExecutions, getSharingTasks, getSharingTasksSettings, patchSharingTask, updateSharingTasksSettings };
+export { cancelSharingTask, clearCache, configureSharingTasksSettings, createSharingTask, sharingTasksExport as default, deleteSharingTask, executeSharingTasks, getSharingTask, getSharingTaskExecution, getSharingTaskExecutionFile, getSharingTaskExecutions, getSharingTasks, getSharingTasksSettings, patchSharingTask, updateSharingTasksSettings };

package/spaces.d.ts

@@ -1,5 +1,5 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/spaces.d.ts
 /**
@@ -7,36 +7,24 @@ import "./chunks/invoke-fetch-C1Z0RJYU.js";
  */
 type ActionName = "change_owner" | "create" | "read" | "update" | "delete" | "publish" | "link_environment" | "restrict";
 type Assignment = {
-  /** The userId or groupId based on the type. */
-  assigneeId: string;
-  /** The date and time when the space was created. */
-  readonly createdAt?: string;
-  /** The ID of the user who created the assignment. */
+  /** The userId or groupId based on the type. */assigneeId: string; /** The date and time when the space was created. */
+  readonly createdAt?: string; /** The ID of the user who created the assignment. */
   readonly createdBy?: string;
   readonly id: string;
   readonly links: {
     self: Link;
     space?: Link;
-  };
-  /** The roles assigned to a user or group. Must not be empty. */
-  roles: RoleType[];
-  /** The unique identifier for the space. */
-  readonly spaceId: string;
-  /** The unique identifier for the tenant. */
-  readonly tenantId: string;
-  /** The type of assignment such as user or group */
-  type: AssignmentType;
-  /** The date and time when the space was updated. */
-  readonly updatedAt?: string;
-  /** The ID of the user who updated the assignment. */
+  }; /** The roles assigned to a user or group. Must not be empty. */
+  roles: RoleType[]; /** The unique identifier for the space. */
+  readonly spaceId: string; /** The unique identifier for the tenant. */
+  readonly tenantId: string; /** The type of assignment such as user or group */
+  type: AssignmentType; /** The date and time when the space was updated. */
+  readonly updatedAt?: string; /** The ID of the user who updated the assignment. */
   readonly updatedBy?: string;
 };
 type AssignmentCreate = {
-  /** The userId or groupId based on the type. */
-  assigneeId: string;
-  /** The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call `GET /spaces/{spaceId}` and inspect the `meta.assignableRoles` object. */
-  roles: RoleType[];
-  /** The type of assignment such as user or group */
+  /** The userId or groupId based on the type. */assigneeId: string; /** The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call `GET /spaces/{spaceId}` and inspect the `meta.assignableRoles` object. */
+  roles: RoleType[]; /** The type of assignment such as user or group */
   type: AssignmentType;
 };
 /**
@@ -44,8 +32,7 @@ type AssignmentCreate = {
  */
 type AssignmentType = "user" | "group" | "bot";
 type AssignmentUpdate = {
-  /** The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call `GET /spaces/{spaceId}` and inspect the `meta.assignableRoles` object. */
-  roles?: RoleType[];
+  /** The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call `GET /spaces/{spaceId}` and inspect the `meta.assignableRoles` object. */roles?: RoleType[];
 };
 type Assignments = {
   data?: Assignment[];
@@ -55,29 +42,21 @@ type Assignments = {
     self: Link;
   };
   readonly meta?: {
-    /** The total number of assignments matching the current filter. */
-    count: number;
+    /** The total number of assignments matching the current filter. */count: number;
   };
 };
 /**
  * An error object.
  */
 type Error = {
-  /** The error code. */
-  code: string;
-  /** A human-readable explanation specific to the occurrence of this problem. */
-  detail?: string;
-  /** Additional properties relating to the error. */
+  /** The error code. */code: string; /** A human-readable explanation specific to the occurrence of this problem. */
+  detail?: string; /** Additional properties relating to the error. */
   meta?: {
-    /** References to the source of the error. */
-    source?: {
-      /** The URI query parameter that caused the error. */
-      parameter?: string;
-      /** A JSON pointer to the property that caused the error. */
+    /** References to the source of the error. */source?: {
+      /** The URI query parameter that caused the error. */parameter?: string; /** A JSON pointer to the property that caused the error. */
       pointer?: string;
     };
-  };
-  /** Summary of the problem. */
+  }; /** Summary of the problem. */
   title: string;
 };
 type Errors = {
@@ -94,9 +73,7 @@ type Errors = {
   /** @deprecated
    * References to the source of the error. */
   source?: {
-    /** The URI query parameter that caused the error. */
-    parameter?: string;
-    /** A JSON pointer to the property that caused the error. */
+    /** The URI query parameter that caused the error. */parameter?: string; /** A JSON pointer to the property that caused the error. */
     pointer?: string;
   };
   /** @deprecated
@@ -105,8 +82,7 @@ type Errors = {
   traceId?: string;
 };
 type Link = {
-  /** URL that defines the resource. */
-  href: string;
+  /** URL that defines the resource. */href: string;
 };
 /**
  * Supported roles by space type:
@@ -116,48 +92,34 @@ type Link = {
  */
 type RoleType = "consumer" | "contributor" | "dataconsumer" | "datapreview" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
 type Share = {
-  /** The userId or groupId based on the type. */
-  assigneeId: string;
-  readonly createdAt?: string;
-  /** The ID of the user who created the share. */
-  readonly createdBy?: string;
-  /** If the share is disabled (effective ONLY for link shares). */
+  /** The userId or groupId based on the type. */assigneeId: string;
+  readonly createdAt?: string; /** The ID of the user who created the share. */
+  readonly createdBy?: string; /** If the share is disabled (effective ONLY for link shares). */
   disabled?: boolean;
   readonly id: string;
   readonly links?: {
     self: Link;
     space?: Link;
-  };
-  /** The ID of the shared resource. */
-  resourceId: string;
-  /** The name of the shared resource. */
-  resourceName?: string;
-  /** The type of the shared resource. */
-  resourceType: "app";
-  /** The roles assigned to the assigneeId. */
+  }; /** The ID of the shared resource. */
+  resourceId: string; /** The name of the shared resource. */
+  resourceName?: string; /** The type of the shared resource. */
+  resourceType: "app"; /** The roles assigned to the assigneeId. */
   roles?: ShareRoleType[];
   readonly spaceId: string;
   readonly tenantId: string;
   type: ShareType;
-  readonly updatedAt?: string;
-  /** The ID of the user who updated the share. */
+  readonly updatedAt?: string; /** The ID of the user who updated the share. */
   readonly updatedBy?: string;
 };
 type ShareCreate = {
-  /** The userId or groupId based on the type. */
-  assigneeId: string;
-  /** The resource id for the shared item. */
-  resourceId: string;
-  /** The resource type for the shared item. */
-  resourceType: string;
-  /** The roles assigned to the assigneeId. */
+  /** The userId or groupId based on the type. */assigneeId: string; /** The resource id for the shared item. */
+  resourceId: string; /** The resource type for the shared item. */
+  resourceType: string; /** The roles assigned to the assigneeId. */
   roles: ShareRoleType[];
   type: ShareType;
 };
 type SharePatch = {
-  /** The operation to be performed. */
-  op: "replace";
-  /** Field of Share to be patched (updated). */
+  /** The operation to be performed. */op: "replace"; /** Field of Share to be patched (updated). */
   path: "/roles" | "/disabled";
   /** The value to be used within the operations.
    * - roles: The roles assigned to the assigneeId.
@@ -179,58 +141,39 @@ type Shares = {
     self: Link;
   };
   readonly meta?: {
-    /** The total number of Shares matching the current filter. */
-    count: number;
+    /** The total number of Shares matching the current filter. */count: number;
   };
 };
 /**
  * A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
  */
 type Space = {
-  /** The date and time when the space was created. */
-  readonly createdAt?: string;
-  /** The ID of the user who created the space. */
-  readonly createdBy?: string;
-  /** The description of the space. Personal spaces do not have a description. */
-  description?: string;
-  /** A unique identifier for the space, for example, 62716f4b39b865ece543cd45. */
+  /** The date and time when the space was created. */readonly createdAt?: string; /** The ID of the user who created the space. */
+  readonly createdBy?: string; /** The description of the space. Personal spaces do not have a description. */
+  description?: string; /** A unique identifier for the space, for example, 62716f4b39b865ece543cd45. */
   readonly id: string;
   readonly links: {
     assignments: Link;
     self: Link;
-  };
-  /** Information about the space settings. */
+  }; /** Information about the space settings. */
   readonly meta?: {
-    /** The list of actions allowed by the current user in this space. */
-    actions: ActionName[];
-    /** The list of roles that could be assigned in this space. */
-    assignableRoles: RoleType[];
-    /** The list of roles assigned to the current user in this space. */
+    /** The list of actions allowed by the current user in this space. */actions: ActionName[]; /** The list of roles that could be assigned in this space. */
+    assignableRoles: RoleType[]; /** The list of roles assigned to the current user in this space. */
     roles: RoleType[];
-  };
-  /** The name of the space. Personal spaces do not have a name. */
-  name: string;
-  /** The ID for the space owner. */
-  readonly ownerId?: string;
-  /** The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct. */
-  readonly tenantId: string;
-  /** The type of space such as shared, managed, and so on. */
-  readonly type?: "shared" | "managed" | "data";
-  /** The date and time when the space was updated. */
+  }; /** The name of the space. Personal spaces do not have a name. */
+  name: string; /** The ID for the space owner. */
+  readonly ownerId?: string; /** The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct. */
+  readonly tenantId: string; /** The type of space such as shared, managed, and so on. */
+  readonly type?: "shared" | "managed" | "data"; /** The date and time when the space was updated. */
   readonly updatedAt?: string;
 };
 type SpaceCreate = {
-  /** The description of the space. Personal spaces do not have a description. */
-  description?: string;
-  /** The name of the space. Personal spaces do not have a name. */
-  name: string;
-  /** The type of space such as shared, managed, and so on. */
+  /** The description of the space. Personal spaces do not have a description. */description?: string; /** The name of the space. Personal spaces do not have a name. */
+  name: string; /** The type of space such as shared, managed, and so on. */
   type: "shared" | "managed" | "data";
 };
 type SpacePatch = {
-  /** The operation to be performed. */
-  op: "replace";
-  /** Field of space to be patched (updated). */
+  /** The operation to be performed. */op: "replace"; /** Field of space to be patched (updated). */
   path: "/name" | "/ownerId" | "/description";
   /** The value to be used within the operations.
    * - name: The name (string) of space of maxLength 256 of pattern: ^[^\"\*\?\<\>\/\|\\\:]+$
@@ -249,11 +192,8 @@ type SpaceTypes = {
   readonly data?: SpaceType[];
 };
 type SpaceUpdate = {
-  /** The description of the space. Personal spaces do not have a description. */
-  description?: string;
-  /** The name of the space. */
-  name?: string;
-  /** The user ID of the space owner. */
+  /** The description of the space. Personal spaces do not have a description. */description?: string; /** The name of the space. */
+  name?: string; /** The user ID of the space owner. */
   ownerId?: string;
 };
 type Spaces = {
@@ -264,13 +204,9 @@ type Spaces = {
     self: Link;
   };
   readonly meta?: {
-    /** The total number of spaces matching the current filter. */
-    count: number;
-    /** The meta related to personal space when applicable. */
+    /** The total number of spaces matching the current filter. */count: number; /** The meta related to personal space when applicable. */
     readonly personalSpace?: {
-      /** The list of actions allowed by the current user in this space. */
-      actions: ActionName[];
-      /** resource type */
+      /** The list of actions allowed by the current user in this space. */actions: ActionName[]; /** resource type */
       resourceType: string;
     };
   };
@@ -282,21 +218,13 @@ type Spaces = {
  * @throws GetSpacesHttpError
  */
 declare function getSpaces(query: {
-  /** Action on space. Supports only "?action=publish". */
-  action?: string;
-  /** Maximum number of spaces to return. */
-  limit?: number;
-  /** Space name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. For example, "?name=fin" will get "finance", "Final" and "Griffin". */
-  name?: string;
-  /** The next page cursor. Next links make use of this. */
-  next?: string;
-  /** Space ownerId to filter by. For example, "?ownerId=123". */
-  ownerId?: string;
-  /** The previous page cursor. Previous links make use of this. */
-  prev?: string;
-  /** Field to sort by. Prefix with +/- to indicate asc/desc. For example, "?sort=+name" to sort ascending on Name. Supported fields are "type", "name" and "createdAt". */
-  sort?: string;
-  /** Type(s) of space to filter. For example, "?type=managed,shared". */
+  /** Action on space. Supports only "?action=publish". */action?: string; /** Maximum number of spaces to return. */
+  limit?: number; /** Space name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. For example, "?name=fin" will get "finance", "Final" and "Griffin". */
+  name?: string; /** The next page cursor. Next links make use of this. */
+  next?: string; /** Space ownerId to filter by. For example, "?ownerId=123". */
+  ownerId?: string; /** The previous page cursor. Previous links make use of this. */
+  prev?: string; /** Field to sort by. Prefix with +/- to indicate asc/desc. For example, "?sort=+name" to sort ascending on Name. Supported fields are "type", "name" and "createdAt". */
+  sort?: string; /** Type(s) of space to filter. For example, "?type=managed,shared". */
   type?: string;
 }, options?: ApiCallOptions): Promise<GetSpacesHttpResponse>;
 type GetSpacesHttpResponse = {
@@ -422,15 +350,10 @@ type UpdateSpaceHttpError = {
  * @throws GetSpaceAssignmentsHttpError
  */
 declare function getSpaceAssignments(spaceId: string, query: {
-  /** Filters assignment for a specific assigneeid. */
-  assigneeId?: string;
-  /** Maximum number of assignments to return. */
-  limit?: number;
-  /** The next page cursor. Next links make use of this. */
-  next?: string;
-  /** The previous page cursor. Previous links make use of this. */
-  prev?: string;
-  /** The type of assignment. Supported values are user or group. */
+  /** Filters assignment for a specific assigneeid. */assigneeId?: string; /** Maximum number of assignments to return. */
+  limit?: number; /** The next page cursor. Next links make use of this. */
+  next?: string; /** The previous page cursor. Previous links make use of this. */
+  prev?: string; /** The type of assignment. Supported values are user or group. */
   type?: AssignmentType;
 }, options?: ApiCallOptions): Promise<GetSpaceAssignmentsHttpResponse>;
 type GetSpaceAssignmentsHttpResponse = {
@@ -526,23 +449,14 @@ type UpdateSpaceAssignmentHttpError = {
  * @throws GetSpaceSharesHttpError
  */
 declare function getSpaceShares(spaceId: string, query: {
-  /** The ID of the group to which the resource is shared. */
-  groupId?: string;
-  /** Maximum number of shares to return. */
-  limit?: number;
-  /** The name of the shared resource. */
-  name?: string;
-  /** The next page cursor. Next links make use of this. */
-  next?: string;
-  /** The previous page cursor. Previous links make use of this. */
-  prev?: string;
-  /** The ID of the shared resource. */
-  resourceId?: string;
-  /** The type of the shared resource. */
-  resourceType?: string;
-  /** The type of share. `user` shares assign to a specific user, `group` shares assign to a specific group, and `link` shares provide anonymous access to a resource. */
-  type?: ShareType;
-  /** The ID of the user to which the resource is shared. */
+  /** The ID of the group to which the resource is shared. */groupId?: string; /** Maximum number of shares to return. */
+  limit?: number; /** The name of the shared resource. */
+  name?: string; /** The next page cursor. Next links make use of this. */
+  next?: string; /** The previous page cursor. Previous links make use of this. */
+  prev?: string; /** The ID of the shared resource. */
+  resourceId?: string; /** The type of the shared resource. */
+  resourceType?: string; /** The type of share. `user` shares assign to a specific user, `group` shares assign to a specific group, and `link` shares provide anonymous access to a resource. */
+  type?: ShareType; /** The ID of the user to which the resource is shared. */
   userId?: string;
 }, options?: ApiCallOptions): Promise<GetSpaceSharesHttpResponse>;
 type GetSpaceSharesHttpResponse = {

package/spaces.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-BqxAMJ9M.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/spaces.ts
 /**
@@ -314,7 +314,6 @@ const spacesExport = {
 	patchShare,
 	clearCache
 };
-var spaces_default = spacesExport;
 
 //#endregion
-export { clearCache, createSpace, createSpaceAssignment, createSpaceShare, spaces_default as default, deleteSpace, deleteSpaceAssignment, deleteSpaceShare, getSpace, getSpaceAssignment, getSpaceAssignments, getSpaceShare, getSpaceShares, getSpaceTypes, getSpaces, patchShare, patchSpace, updateSpace, updateSpaceAssignment };
+export { clearCache, createSpace, createSpaceAssignment, createSpaceShare, spacesExport as default, deleteSpace, deleteSpaceAssignment, deleteSpaceShare, getSpace, getSpaceAssignment, getSpaceAssignments, getSpaceShare, getSpaceShares, getSpaceTypes, getSpaces, patchShare, patchSpace, updateSpace, updateSpaceAssignment };