@qlik/api 1.24.0 → 1.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/api-keys.d.ts +1 -1
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +1 -1
  4. package/apps.js +2 -2
  5. package/audits.d.ts +1 -1
  6. package/audits.js +2 -2
  7. package/auth.js +2 -2
  8. package/automations.d.ts +1 -1
  9. package/automations.js +2 -2
  10. package/brands.d.ts +1 -1
  11. package/brands.js +2 -2
  12. package/chunks/{3DYV7KOJ.js → 2BRBIRM2.js} +2 -2
  13. package/chunks/{7BDAXGID.js → 3RGGGGAR.js} +6 -9
  14. package/chunks/{6DEESTGF.js → 4D5NADHK.js} +4 -4
  15. package/chunks/{OIQ5ELGS.js → 7SNOQCIQ.js} +1 -1
  16. package/chunks/{UA6BE3VB.js → AMO5NATA.js} +2 -2
  17. package/chunks/{BL5PJM4B.js → HGRF5TX3.js} +1 -1
  18. package/chunks/{N3ZFICDU.js → MGXEGSJC.js} +3 -3
  19. package/chunks/{I5UOE4ZZ.js → NBW6PHZU.js} +120 -44
  20. package/chunks/{6QRR5VUM.js → QOOCP2TS.js} +4 -3
  21. package/chunks/{CZC7KEJN.js → UV5COPU3.js} +3 -3
  22. package/collections.d.ts +1 -1
  23. package/collections.js +2 -2
  24. package/csp-origins.d.ts +13 -13
  25. package/csp-origins.js +2 -2
  26. package/data-assets.d.ts +2 -2
  27. package/data-assets.js +2 -2
  28. package/data-connections.d.ts +1 -1
  29. package/data-connections.js +2 -2
  30. package/data-credentials.d.ts +1 -1
  31. package/data-credentials.js +2 -2
  32. package/data-files.d.ts +1 -1
  33. package/data-files.js +2 -2
  34. package/docs/qix.md +28 -8
  35. package/extensions.d.ts +1 -1
  36. package/extensions.js +2 -2
  37. package/glossaries.d.ts +1 -1
  38. package/glossaries.js +2 -2
  39. package/groups.d.ts +3 -3
  40. package/groups.js +2 -2
  41. package/identity-providers.d.ts +28 -3
  42. package/identity-providers.js +2 -2
  43. package/index.d.ts +1 -1
  44. package/index.js +5 -5
  45. package/interceptors.d.ts +1 -1
  46. package/interceptors.js +1 -1
  47. package/{invoke-fetch-types-BLrpeZOL.d.ts → invoke-fetch-types-BXn-uSF5.d.ts} +27 -1
  48. package/items.d.ts +3 -3
  49. package/items.js +2 -2
  50. package/licenses.d.ts +1 -1
  51. package/licenses.js +2 -2
  52. package/package.json +3 -3
  53. package/qix.d.ts +35 -2
  54. package/qix.js +2 -2
  55. package/quotas.d.ts +1 -1
  56. package/quotas.js +2 -2
  57. package/reload-tasks.d.ts +1 -1
  58. package/reload-tasks.js +2 -2
  59. package/reloads.d.ts +1 -1
  60. package/reloads.js +2 -2
  61. package/reports.d.ts +9 -7
  62. package/reports.js +2 -2
  63. package/roles.d.ts +2 -2
  64. package/roles.js +2 -2
  65. package/spaces.d.ts +23 -23
  66. package/spaces.js +2 -2
  67. package/temp-contents.d.ts +1 -1
  68. package/temp-contents.js +2 -2
  69. package/tenants.d.ts +1 -1
  70. package/tenants.js +2 -2
  71. package/themes.d.ts +1 -1
  72. package/themes.js +2 -2
  73. package/transports.d.ts +1 -1
  74. package/transports.js +2 -2
  75. package/users.d.ts +38 -27
  76. package/users.js +2 -2
  77. package/web-integrations.d.ts +1 -1
  78. package/web-integrations.js +2 -2
  79. package/web-notifications.d.ts +1 -1
  80. package/web-notifications.js +2 -2
  81. package/webhooks.d.ts +1 -1
  82. package/webhooks.js +2 -2
package/qix.js CHANGED
@@ -2,8 +2,8 @@ import {
2
2
  openAppSession,
3
3
  qix_default,
4
4
  withHostConfig
5
- } from "./chunks/OIQ5ELGS.js";
6
- import "./chunks/CZC7KEJN.js";
5
+ } from "./chunks/7SNOQCIQ.js";
6
+ import "./chunks/UV5COPU3.js";
7
7
  export {
8
8
  qix_default as default,
9
9
  openAppSession,
package/quotas.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
package/quotas.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/quotas.ts
package/reload-tasks.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type Error = {
package/reload-tasks.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/reload-tasks.ts
package/reloads.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type Error = {
package/reloads.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/reloads.ts
package/reports.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -59,10 +59,10 @@ type Error = {
59
59
  errors?: ExportErrors;
60
60
  };
61
61
  /**
62
- * Output to be used to export a excel template.
62
+ * Output to be used to export an excel template.
63
63
  */
64
64
  type ExcelOutput = {
65
- /** The image format of the report to be produced. */
65
+ /** The output format of the report to be produced. */
66
66
  outFormat?: "xlsx";
67
67
  };
68
68
  /**
@@ -207,7 +207,7 @@ type NxPatch = {
207
207
  type OutputItem = {
208
208
  /** The callback to be performed once the report is done. */
209
209
  callBackAction?: CallBackAction;
210
- /** Output to be used to export a excel template. */
210
+ /** Output to be used to export an excel template. */
211
211
  excelOutput?: ExcelOutput;
212
212
  /** Output to be used to export a single visualization as image. */
213
213
  imageOutput?: ImageOutput;
@@ -239,7 +239,7 @@ type OutputItem = {
239
239
  * - image requires imageOutput to be set
240
240
  * - csv doesn't have csv output
241
241
  * - xlsx requires xlsxOutput to be set */
242
- type: "image" | "pdf" | "xlsx" | "jsondata" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv" | "cycle";
242
+ type: "image" | "pdf" | "xlsx" | "jsondata" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv" | "cycle" | "html";
243
243
  };
244
244
  /**
245
245
  * Output to be used to export a composition of templates as pdf.
@@ -342,6 +342,8 @@ type ReportRequest = {
342
342
  senseDataTemplate?: SenseDataTemplate;
343
343
  /** Used to produce reports from a template file. */
344
344
  senseExcelTemplate?: SenseFileTemplate;
345
+ /** Used to produce reports from a template file. */
346
+ senseHtmlTemplate?: SenseFileTemplate;
345
347
  /** Used to export a single visualization as pdf, pptx or png. */
346
348
  senseImageTemplate?: SenseImageTemplate;
347
349
  /** Used to produce reports from a template file. */
@@ -349,7 +351,7 @@ type ReportRequest = {
349
351
  /** Used to export a sheet as pdf or pptx. */
350
352
  senseSheetTemplate?: SenseSheetTemplate;
351
353
  /** Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR.
352
- * Please note that sense-pixel-perfect-template-1.0, sense-story-x.0 and qv-data-x.0 are only for internal use.
354
+ * Please note that sense-pixel-perfect-template-1.0, sense-html-template-1.0, sense-story-x.0 and qv-data-x.0 are only for internal use.
353
355
  *
354
356
  * Each type requires a specific template to be provided:
355
357
  * - composition-1.0 requires compositionTemplates to be set
@@ -364,7 +366,7 @@ type ReportRequest = {
364
366
  * - sense-image-1.0 supports pdf, pptx and png output types
365
367
  * - sense-sheet-1.0 supports pdf, pptx output type
366
368
  * - sense-data-1.0 supports xlsx output type */
367
- type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0";
369
+ type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0" | "sense-html-template-1.0";
368
370
  };
369
371
  type ReportStatus = {
370
372
  /** @deprecated
package/reports.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/reports.ts
package/roles.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type CreateRole = {
@@ -207,7 +207,7 @@ type GetRoleHttpError = {
207
207
  * @param body an object with the body content
208
208
  * @throws PatchRoleHttpError
209
209
  */
210
- declare const patchRole: (id: string, body: PatchRoles[], options?: ApiCallOptions) => Promise<PatchRoleHttpResponse>;
210
+ declare const patchRole: (id: string, body: PatchRoles, options?: ApiCallOptions) => Promise<PatchRoleHttpResponse>;
211
211
  type PatchRoleHttpResponse = {
212
212
  data: void;
213
213
  headers: Headers;
package/roles.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/roles.ts
package/spaces.d.ts CHANGED
@@ -1,10 +1,10 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
5
- * The supported actions for user-created spaces like Shared or Managed spaces.
5
+ * The supported actions for user-created spaces.
6
6
  */
7
- type ActionName = "create" | "read" | "update" | "delete" | "publish";
7
+ type ActionName = "change_owner" | "create" | "read" | "update" | "delete" | "publish";
8
8
  type Assignment = {
9
9
  /** The userId or groupId based on the type. */
10
10
  assigneeId: string;
@@ -33,7 +33,7 @@ type Assignment = {
33
33
  type AssignmentCreate = {
34
34
  /** The userId or groupId based on the type. */
35
35
  assigneeId: string;
36
- /** The roles assigned to the assigneeId. */
36
+ /** 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. */
37
37
  roles: RoleType[];
38
38
  /** The type of assignment such as user or group */
39
39
  type: AssignmentType;
@@ -43,7 +43,7 @@ type AssignmentCreate = {
43
43
  */
44
44
  type AssignmentType = "user" | "group";
45
45
  type AssignmentUpdate = {
46
- /** The roles assigned to the assigneeId. */
46
+ /** 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. */
47
47
  roles?: RoleType[];
48
48
  };
49
49
  type Assignments = {
@@ -111,9 +111,9 @@ type Link = {
111
111
  * Supported roles by space type:
112
112
  * - Shared: codeveloper, consumer, dataconsumer, facilitator, producer
113
113
  * - Managed: consumer, contributor, dataconsumer, facilitator, publisher, basicconsumer
114
- * - Data: consumer, dataconsumer, facilitator, operator, producer, publisher
114
+ * - Data: consumer, dataconsumer, datapreview, facilitator, operator, producer, publisher
115
115
  */
116
- type RoleType = "consumer" | "contributor" | "dataconsumer" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
116
+ type RoleType = "consumer" | "contributor" | "dataconsumer" | "datapreview" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
117
117
  /**
118
118
  * The supported roles for Shared spaces.
119
119
  */
@@ -249,7 +249,7 @@ type GetSpacesHttpError = {
249
249
  status: number;
250
250
  };
251
251
  /**
252
- * Creates a space.
252
+ * Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.
253
253
  *
254
254
  * @param body an object with the body content
255
255
  * @throws CreateSpaceHttpError
@@ -266,7 +266,7 @@ type CreateSpaceHttpError = {
266
266
  status: number;
267
267
  };
268
268
  /**
269
- * Gets a list of distinct space types.
269
+ * Gets a list of distinct space types available for use in the tenant.
270
270
  *
271
271
  * @throws GetSpaceTypesHttpError
272
272
  */
@@ -316,7 +316,7 @@ type GetSpaceHttpError = {
316
316
  status: number;
317
317
  };
318
318
  /**
319
- * Patches (updates) a space (partially).
319
+ * Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.
320
320
  *
321
321
  * @param spaceId The ID of the space to update.
322
322
  * @param body an object with the body content
@@ -334,7 +334,7 @@ type PatchSpaceHttpError = {
334
334
  status: number;
335
335
  };
336
336
  /**
337
- * Updates a space.
337
+ * Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.
338
338
  *
339
339
  * @param spaceId The ID of the space to update.
340
340
  * @param body an object with the body content
@@ -352,7 +352,7 @@ type UpdateSpaceHttpError = {
352
352
  status: number;
353
353
  };
354
354
  /**
355
- * Retrieves the assignments of the space matching the query.
355
+ * Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all `assignableRoles` by default.
356
356
  *
357
357
  * @param spaceId The ID of the space of the assignment.
358
358
  * @param query an object with query parameters
@@ -383,7 +383,7 @@ type GetSpaceAssignmentsHttpError = {
383
383
  status: number;
384
384
  };
385
385
  /**
386
- * Creates an assignment.
386
+ * Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all `assignableRoles` by default. Only one assignment can exist per space, per user or group.
387
387
  *
388
388
  * @param spaceId The ID of the space of the assignment.
389
389
  * @param body an object with the body content
@@ -419,7 +419,7 @@ type DeleteSpaceAssignmentHttpError = {
419
419
  status: number;
420
420
  };
421
421
  /**
422
- * Retrieves a single assignment by ID.
422
+ * Retrieves a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID.
423
423
  *
424
424
  * @param spaceId The ID of the space of the assignment.
425
425
  * @param assignmentId The ID of the assignment to retrieve.
@@ -437,7 +437,7 @@ type GetSpaceAssignmentHttpError = {
437
437
  status: number;
438
438
  };
439
439
  /**
440
- * Updates a single assignment by ID. The complete list of roles must be provided.
440
+ * Updates a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.
441
441
  *
442
442
  * @param spaceId The ID of the space of the assignment.
443
443
  * @param assignmentId The ID of the assignment to update.
@@ -468,14 +468,14 @@ interface SpacesAPI {
468
468
  */
469
469
  getSpaces: typeof getSpaces;
470
470
  /**
471
- * Creates a space.
471
+ * Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.
472
472
  *
473
473
  * @param body an object with the body content
474
474
  * @throws CreateSpaceHttpError
475
475
  */
476
476
  createSpace: typeof createSpace;
477
477
  /**
478
- * Gets a list of distinct space types.
478
+ * Gets a list of distinct space types available for use in the tenant.
479
479
  *
480
480
  * @throws GetSpaceTypesHttpError
481
481
  */
@@ -495,7 +495,7 @@ interface SpacesAPI {
495
495
  */
496
496
  getSpace: typeof getSpace;
497
497
  /**
498
- * Patches (updates) a space (partially).
498
+ * Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.
499
499
  *
500
500
  * @param spaceId The ID of the space to update.
501
501
  * @param body an object with the body content
@@ -503,7 +503,7 @@ interface SpacesAPI {
503
503
  */
504
504
  patchSpace: typeof patchSpace;
505
505
  /**
506
- * Updates a space.
506
+ * Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.
507
507
  *
508
508
  * @param spaceId The ID of the space to update.
509
509
  * @param body an object with the body content
@@ -511,7 +511,7 @@ interface SpacesAPI {
511
511
  */
512
512
  updateSpace: typeof updateSpace;
513
513
  /**
514
- * Retrieves the assignments of the space matching the query.
514
+ * Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all `assignableRoles` by default.
515
515
  *
516
516
  * @param spaceId The ID of the space of the assignment.
517
517
  * @param query an object with query parameters
@@ -519,7 +519,7 @@ interface SpacesAPI {
519
519
  */
520
520
  getSpaceAssignments: typeof getSpaceAssignments;
521
521
  /**
522
- * Creates an assignment.
522
+ * Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all `assignableRoles` by default. Only one assignment can exist per space, per user or group.
523
523
  *
524
524
  * @param spaceId The ID of the space of the assignment.
525
525
  * @param body an object with the body content
@@ -535,7 +535,7 @@ interface SpacesAPI {
535
535
  */
536
536
  deleteSpaceAssignment: typeof deleteSpaceAssignment;
537
537
  /**
538
- * Retrieves a single assignment by ID.
538
+ * Retrieves a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID.
539
539
  *
540
540
  * @param spaceId The ID of the space of the assignment.
541
541
  * @param assignmentId The ID of the assignment to retrieve.
@@ -543,7 +543,7 @@ interface SpacesAPI {
543
543
  */
544
544
  getSpaceAssignment: typeof getSpaceAssignment;
545
545
  /**
546
- * Updates a single assignment by ID. The complete list of roles must be provided.
546
+ * Updates a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.
547
547
  *
548
548
  * @param spaceId The ID of the space of the assignment.
549
549
  * @param assignmentId The ID of the assignment to update.
package/spaces.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/spaces.ts
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
package/temp-contents.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/temp-contents.ts
package/tenants.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
package/tenants.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/tenants.ts
package/themes.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
package/themes.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/themes.ts
package/transports.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type DeleteConfigNotFoundError = {
package/transports.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/transports.ts
package/users.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -14,6 +14,15 @@ type AssignedGroups = {
14
14
  /** The provider type of the group */
15
15
  providerType?: "idp" | "custom";
16
16
  }[];
17
+ /**
18
+ * An array of group reference names and provider type.
19
+ */
20
+ type AssignedGroupsRefNames = {
21
+ /** The name of the group */
22
+ name: string;
23
+ /** The type of provider for the group. */
24
+ providerType: "idp" | "custom";
25
+ }[];
17
26
  /**
18
27
  * An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
19
28
  */
@@ -28,21 +37,7 @@ type AssignedRoles = {
28
37
  readonly type: "default" | "custom";
29
38
  }[];
30
39
  /**
31
- * An array of role reference identifiers.
32
- */
33
- type AssignedRolesRefIDs = {
34
- /** The unique role identitier */
35
- id: string;
36
- }[];
37
- /**
38
- * An array of role reference names.
39
- */
40
- type AssignedRolesRefNames = {
41
- /** The name of the role */
42
- name: string;
43
- }[];
44
- /**
45
- * An array of scopes assigned to user
40
+ * An array of scopes assigned to a user
46
41
  */
47
42
  type AssignedScopes = string[];
48
43
  /**
@@ -132,17 +127,31 @@ type InviteRequestData = {
132
127
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
133
128
  */
134
129
  type JSONPatch = {
135
- /** The operation to be performed. */
136
- op: "replace" | "set (Deprecated)" | "unset (Deprecated)" | "add (Deprecated)" | "renew";
137
- /** A JSON Pointer. */
138
- path: "/name" | "/roles (Deprecated)" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
130
+ /** The operation to be performed. The fields `set`, `unset`, and `add` are deprecated. */
131
+ op: "replace" | "set" | "unset" | "add" | "renew";
132
+ /** A JSON Pointer. The field `roles` is deprecated. */
133
+ path: "/name" | "/roles" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
139
134
  /** The value to be used for this operation. */
140
- value: string | boolean | unknown[] | AssignedRolesRefIDs | AssignedRolesRefNames;
135
+ value: string | boolean | unknown[] | RefIDs | RefNames | AssignedGroupsRefNames;
141
136
  };
142
137
  /**
143
138
  * An array of JSON Patch documents
144
139
  */
145
140
  type JSONPatchArray = JSONPatch[];
141
+ /**
142
+ * An array of entity reference identifiers (e.g. roles, groups).
143
+ */
144
+ type RefIDs = {
145
+ /** The unique identitier */
146
+ id: string;
147
+ }[];
148
+ /**
149
+ * An array of reference names (e.g. roles).
150
+ */
151
+ type RefNames = {
152
+ /** The name of the entity */
153
+ name: string;
154
+ }[];
146
155
  /**
147
156
  * Invitee result item
148
157
  */
@@ -164,7 +173,7 @@ type User = {
164
173
  assignedGroups?: AssignedGroups;
165
174
  /** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
166
175
  assignedRoles?: AssignedRoles;
167
- /** An array of scopes assigned to user */
176
+ /** An array of scopes assigned to a user */
168
177
  readonly assignedScopes?: AssignedScopes;
169
178
  /** @deprecated
170
179
  * Deprecated. Use `createdAt` instead. */
@@ -204,7 +213,7 @@ type User = {
204
213
  * List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use `assignedRoles` instead. */
205
214
  roles?: ("TenantAdmin" | "Developer" | "AnalyticsAdmin" | "DataAdmin" | "DataSpaceCreator" | "ManagedSpaceCreator" | "SharedSpaceCreator")[];
206
215
  /** The status of the user within the tenant. */
207
- status?: "active" | "invited" | "disabled" | "deleted";
216
+ status?: "active" | "invited" | "disabled" | "deleted" | "provisioned";
208
217
  /** The unique user identitier from an identity provider. */
209
218
  subject: string;
210
219
  /** The tenant that the user belongs too. */
@@ -221,7 +230,7 @@ type UserCount = {
221
230
  };
222
231
  type UserPostSchema = {
223
232
  /** The roles to assign to the user. */
224
- assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames;
233
+ assignedRoles?: RefIDs | RefNames;
225
234
  /** The email address for the user. This is a required field when inviting a user. */
226
235
  email?: string;
227
236
  /** The name of the user. */
@@ -259,6 +268,8 @@ type Users = {
259
268
  href: string;
260
269
  };
261
270
  };
271
+ /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
272
+ totalResults?: number;
262
273
  };
263
274
  /**
264
275
  * Returns a list of users using cursor-based pagination.
@@ -315,7 +326,7 @@ declare const getUsers: (query: {
315
326
  * The role to filter by. Deprecated. */
316
327
  role?: string;
317
328
  /** The field to sort by, with +/- prefix indicating sort order */
318
- sort?: "name" | "+name" | "-name";
329
+ sort?: "name" | "+name" | "-name" | "_id" | "+_id" | "-_id" | "id" | "+id" | "-id" | "tenantId" | "+tenantId" | "-tenantId" | "clientId" | "+clientId" | "-clientId" | "status" | "+status" | "-status" | "subject" | "+subject" | "-subject" | "email" | "+email" | "-email" | "inviteExpiry" | "+inviteExpiry" | "-inviteExpiry" | "createdAt" | "+createdAt" | "-createdAt";
319
330
  /** @deprecated
320
331
  * The user parameter to sort by. Deprecated. Use `sort` instead. */
321
332
  sortBy?: "name";
@@ -327,7 +338,7 @@ declare const getUsers: (query: {
327
338
  startingAfter?: string;
328
339
  /** @deprecated
329
340
  * The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
330
- status?: "active" | "invited" | "disabled" | "deleted";
341
+ status?: "active" | "invited" | "disabled" | "deleted" | "provisioned";
331
342
  /** @deprecated
332
343
  * The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
333
344
  subject?: string;
@@ -593,4 +604,4 @@ interface UsersAPI {
593
604
  */
594
605
  declare const usersExport: UsersAPI;
595
606
 
596
- export { type AssignedGroups, type AssignedRoles, type AssignedRolesRefIDs, type AssignedRolesRefNames, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, inviteUsers, patchUser };
607
+ export { type AssignedGroups, type AssignedGroupsRefNames, type AssignedRoles, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type RefIDs, type RefNames, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, inviteUsers, patchUser };
package/users.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/users.ts
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/web-integrations.ts
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/UA6BE3VB.js";
5
- import "./chunks/CZC7KEJN.js";
4
+ } from "./chunks/AMO5NATA.js";
5
+ import "./chunks/UV5COPU3.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/web-notifications.ts
package/webhooks.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type Delivery = {