@qlik/api 1.22.0 → 1.24.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 (84) hide show
  1. package/api-keys.d.ts +6 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +10 -2
  4. package/apps.js +2 -2
  5. package/audits.d.ts +4 -16
  6. package/audits.js +2 -2
  7. package/auth.js +2 -2
  8. package/automations.d.ts +2 -59
  9. package/automations.js +3 -19
  10. package/brands.d.ts +23 -23
  11. package/brands.js +2 -2
  12. package/chunks/{GZRY5VHW.js → 3DYV7KOJ.js} +2 -2
  13. package/chunks/{SEBN4KFZ.js → 6DEESTGF.js} +2 -2
  14. package/chunks/{PR52AAWU.js → 6QRR5VUM.js} +36 -32
  15. package/chunks/7BDAXGID.js +116 -0
  16. package/chunks/{TGDZVKG2.js → BL5PJM4B.js} +1 -1
  17. package/chunks/{SNQHDUYY.js → CZC7KEJN.js} +3 -3
  18. package/chunks/{OEVNZ5IQ.js → I5UOE4ZZ.js} +90 -85
  19. package/chunks/{KBR7JBWC.js → N3ZFICDU.js} +38 -24
  20. package/chunks/{VHPC6L7L.js → OIQ5ELGS.js} +1 -1
  21. package/chunks/{TUPLQG25.js → UA6BE3VB.js} +2 -2
  22. package/chunks/{EUWNVVK5.js → VX3MQBE7.js} +1 -1
  23. package/collections.d.ts +1 -1
  24. package/collections.js +2 -2
  25. package/csp-origins.d.ts +1 -1
  26. package/csp-origins.js +2 -2
  27. package/data-assets.d.ts +1 -1
  28. package/data-assets.js +2 -2
  29. package/data-connections.d.ts +2 -2
  30. package/data-connections.js +2 -2
  31. package/data-credentials.d.ts +64 -2
  32. package/data-credentials.js +11 -2
  33. package/data-files.d.ts +1 -1
  34. package/data-files.js +2 -2
  35. package/docs/rest.md +47 -0
  36. package/extensions.d.ts +1 -1
  37. package/extensions.js +2 -2
  38. package/glossaries.d.ts +3 -4
  39. package/glossaries.js +2 -2
  40. package/groups.d.ts +1 -1
  41. package/groups.js +2 -2
  42. package/identity-providers.d.ts +17 -17
  43. package/identity-providers.js +2 -2
  44. package/index.d.ts +11 -4
  45. package/index.js +90 -79
  46. package/interceptors.d.ts +51 -0
  47. package/interceptors.js +17 -0
  48. package/{global.types-qsBNouXJ.d.ts → invoke-fetch-types-BLrpeZOL.d.ts} +81 -48
  49. package/items.d.ts +1 -1
  50. package/items.js +2 -2
  51. package/licenses.d.ts +3 -1
  52. package/licenses.js +2 -2
  53. package/package.json +2 -2
  54. package/qix.d.ts +6 -3
  55. package/qix.js +2 -2
  56. package/quotas.d.ts +1 -1
  57. package/quotas.js +2 -2
  58. package/reload-tasks.d.ts +1 -1
  59. package/reload-tasks.js +2 -2
  60. package/reloads.d.ts +1 -1
  61. package/reloads.js +2 -2
  62. package/reports.d.ts +42 -4
  63. package/reports.js +2 -2
  64. package/roles.d.ts +98 -4
  65. package/roles.js +28 -4
  66. package/spaces.d.ts +3 -1
  67. package/spaces.js +2 -2
  68. package/temp-contents.d.ts +5 -5
  69. package/temp-contents.js +2 -2
  70. package/tenants.d.ts +25 -16
  71. package/tenants.js +2 -2
  72. package/themes.d.ts +1 -1
  73. package/themes.js +2 -2
  74. package/transports.d.ts +1 -1
  75. package/transports.js +2 -2
  76. package/users.d.ts +4 -39
  77. package/users.js +2 -9
  78. package/web-integrations.d.ts +1 -1
  79. package/web-integrations.js +2 -2
  80. package/web-notifications.d.ts +1 -1
  81. package/web-notifications.js +2 -2
  82. package/webhooks.d.ts +1 -1
  83. package/webhooks.js +2 -2
  84. package/chunks/7RHSSS4W.js +0 -0
package/reloads.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.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/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -110,7 +110,41 @@ type ExportError = {
110
110
  * - "REP-500047" Error setting GroupState.
111
111
  * - "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
112
112
  * - "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
113
- * - "REP-500014" The app did not open within 5 minutes. */
113
+ * - "REP-500014" The app did not open within 10 minutes.
114
+ * - "REP-400017" Static App size exceeded.
115
+ * - "REP-400018" Excel string length exceeded.
116
+ * - "REP-403019" Export is not available for app with enabled directQuery feature.
117
+ * - "REP-409001" App conflict.
118
+ * - "REP-503001" Rest Engine Error.
119
+ * - "REP-400020" Invalid Issuer.
120
+ * - "REP-400028" Invalid Tags.
121
+ * - "REP-409021" Reload timestamp constraint not met.
122
+ * - "REP-429022" Enigma generic abort.
123
+ * - "REP-500023" Validate Report Request Tags failure.
124
+ * - "REP-400024" Cannot extract claims from JWT.
125
+ * - "REP-403025" No entitlement to perform the operation.
126
+ * - "REP-403026" No entitlement to perform the operation. Export capability is off.
127
+ * - "REP-403027" Object without Hypercube or unsupported object type.
128
+ * - "REP-422030" Apply variables error.
129
+ * - "REP-500200" Report Generator error.
130
+ * - "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
131
+ * - "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
132
+ * - "REP-400037" Max number of images exceeded in a report.
133
+ * - "REP-400038" Max number of nested levels exceeded in report.
134
+ * - "REP-400039" Max number of objects exceeded in a report.
135
+ * - "REP-400040" Max number of templates exceeded in a report.
136
+ * - "REP-400041" Unsupported dimension type for level tag.
137
+ * - "REP-500240" Engine Global generic closure error.
138
+ * - "REP-500260" Engine Websocket generic closure error.
139
+ * - "REP-500280" Engine proxy generic closure error.
140
+ * - "REP-400240" Engine Client Global generic closure error
141
+ * - "REP-400260" Engine Client generic closure error.
142
+ * - "REP-400280" Engine Client proxy generic closure error.
143
+ * - "REP-500045" Failure setting Bookmark timestamp.
144
+ * - "REP-400050" Error retrieving outputs.
145
+ * - "REP-400052" Report Request Aborted from internal error.
146
+ * - "REP-500053" Unexpected number of generated cycle reports.
147
+ * - "REP-400054" The number of generated cycle reports exceeds the maximum allowed. */
114
148
  code: string;
115
149
  /** Optional. MAY be used to provide more concrete details. */
116
150
  detail?: string;
@@ -303,6 +337,8 @@ type ReportRequest = {
303
337
  /** Define the request metadata. It includes priority, deadline and future settings on execution policy of the request. */
304
338
  meta?: Meta;
305
339
  output: OutputItem;
340
+ /** The callback to be performed once the report is done. */
341
+ requestCallBackAction?: CallBackAction;
306
342
  senseDataTemplate?: SenseDataTemplate;
307
343
  /** Used to produce reports from a template file. */
308
344
  senseExcelTemplate?: SenseFileTemplate;
@@ -331,13 +367,15 @@ type ReportRequest = {
331
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";
332
368
  };
333
369
  type ReportStatus = {
334
- /** Present when status is failed. */
370
+ /** @deprecated
371
+ * Present when status is failed. Deprecated. Use /reports/{id}/outputs instead. */
335
372
  reasons?: Reason[];
336
373
  /** Errors occured during report generation. */
337
374
  requestErrors?: ExportErrors;
338
375
  /** Count how many times the resolution of this report was attempted. */
339
376
  resolutionAttempts?: number;
340
- /** Present when the status is "done". */
377
+ /** @deprecated
378
+ * Present when the status is "done". Deprecated. Use /reports/{id}/outputs instead. */
341
379
  results?: Result[];
342
380
  /** Status of the requested report. */
343
381
  status: "queued" | "processing" | "done" | "failed" | "aborted" | "visiting" | "aborting";
package/reports.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/reports.ts
package/roles.d.ts CHANGED
@@ -1,6 +1,14 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
+ type CreateRole = {
5
+ /** Selection of scopes to assign to role */
6
+ assignedScopes?: string[];
7
+ /** Role description */
8
+ description?: string;
9
+ /** Role name, needs to be unique */
10
+ name: string;
11
+ };
4
12
  /**
5
13
  * An error object describing the error.
6
14
  */
@@ -55,6 +63,18 @@ type ListRolesResult = {
55
63
  /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
56
64
  totalResults?: number;
57
65
  };
66
+ /**
67
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
68
+ */
69
+ type PatchRole = {
70
+ op: "replace";
71
+ path: "/name" | "/description" | "/assignedScopes";
72
+ value: string | string[];
73
+ };
74
+ /**
75
+ * An array of JSON Patch documents
76
+ */
77
+ type PatchRoles = PatchRole[];
58
78
  type Role = {
59
79
  /** Selection of scopes added to this Role */
60
80
  assignedScopes?: string[];
@@ -129,10 +149,44 @@ type GetRolesHttpError = {
129
149
  headers: Headers;
130
150
  status: number;
131
151
  };
152
+ /**
153
+ * Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the `TenantAdmin` role.
154
+ *
155
+ * @param body an object with the body content
156
+ * @throws CreateRoleHttpError
157
+ */
158
+ declare const createRole: (body: CreateRole, options?: ApiCallOptions) => Promise<CreateRoleHttpResponse>;
159
+ type CreateRoleHttpResponse = {
160
+ data: Role;
161
+ headers: Headers;
162
+ status: number;
163
+ };
164
+ type CreateRoleHttpError = {
165
+ data: Errors;
166
+ headers: Headers;
167
+ status: number;
168
+ };
169
+ /**
170
+ * Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
171
+ *
172
+ * @param id The unique identifier for the role.
173
+ * @throws DeleteRoleHttpError
174
+ */
175
+ declare const deleteRole: (id: string, options?: ApiCallOptions) => Promise<DeleteRoleHttpResponse>;
176
+ type DeleteRoleHttpResponse = {
177
+ data: void;
178
+ headers: Headers;
179
+ status: number;
180
+ };
181
+ type DeleteRoleHttpError = {
182
+ data: Errors;
183
+ headers: Headers;
184
+ status: number;
185
+ };
132
186
  /**
133
187
  * Returns the requested role.
134
188
  *
135
- * @param id The role's unique identifier
189
+ * @param id The unique identifier for the role.
136
190
  * @throws GetRoleHttpError
137
191
  */
138
192
  declare const getRole: (id: string, options?: ApiCallOptions) => Promise<GetRoleHttpResponse>;
@@ -146,6 +200,24 @@ type GetRoleHttpError = {
146
200
  headers: Headers;
147
201
  status: number;
148
202
  };
203
+ /**
204
+ * Updates the requested role. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
205
+ *
206
+ * @param id The unique identifier for the role.
207
+ * @param body an object with the body content
208
+ * @throws PatchRoleHttpError
209
+ */
210
+ declare const patchRole: (id: string, body: PatchRoles[], options?: ApiCallOptions) => Promise<PatchRoleHttpResponse>;
211
+ type PatchRoleHttpResponse = {
212
+ data: void;
213
+ headers: Headers;
214
+ status: number;
215
+ };
216
+ type PatchRoleHttpError = {
217
+ data: Errors;
218
+ headers: Headers;
219
+ status: number;
220
+ };
149
221
  /**
150
222
  * Clears the cache for roles api requests.
151
223
  */
@@ -158,13 +230,35 @@ interface RolesAPI {
158
230
  * @throws GetRolesHttpError
159
231
  */
160
232
  getRoles: typeof getRoles;
233
+ /**
234
+ * Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the `TenantAdmin` role.
235
+ *
236
+ * @param body an object with the body content
237
+ * @throws CreateRoleHttpError
238
+ */
239
+ createRole: typeof createRole;
240
+ /**
241
+ * Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
242
+ *
243
+ * @param id The unique identifier for the role.
244
+ * @throws DeleteRoleHttpError
245
+ */
246
+ deleteRole: typeof deleteRole;
161
247
  /**
162
248
  * Returns the requested role.
163
249
  *
164
- * @param id The role's unique identifier
250
+ * @param id The unique identifier for the role.
165
251
  * @throws GetRoleHttpError
166
252
  */
167
253
  getRole: typeof getRole;
254
+ /**
255
+ * Updates the requested role. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
256
+ *
257
+ * @param id The unique identifier for the role.
258
+ * @param body an object with the body content
259
+ * @throws PatchRoleHttpError
260
+ */
261
+ patchRole: typeof patchRole;
168
262
  /**
169
263
  * Clears the cache for roles api requests.
170
264
  */
@@ -175,4 +269,4 @@ interface RolesAPI {
175
269
  */
176
270
  declare const rolesExport: RolesAPI;
177
271
 
178
- export { type Error, type Errors, type GetRoleHttpError, type GetRoleHttpResponse, type GetRolesHttpError, type GetRolesHttpResponse, type Links, type ListRolesResult, type Role, type RolesAPI, clearCache, rolesExport as default, getRole, getRoles };
272
+ export { type CreateRole, type CreateRoleHttpError, type CreateRoleHttpResponse, type DeleteRoleHttpError, type DeleteRoleHttpResponse, type Error, type Errors, type GetRoleHttpError, type GetRoleHttpResponse, type GetRolesHttpError, type GetRolesHttpResponse, type Links, type ListRolesResult, type PatchRole, type PatchRoleHttpError, type PatchRoleHttpResponse, type PatchRoles, type Role, type RolesAPI, clearCache, createRole, rolesExport as default, deleteRole, getRole, getRoles, patchRole };
package/roles.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/roles.ts
@@ -12,20 +12,44 @@ var getRoles = async (query, options) => invokeFetch("roles", {
12
12
  query,
13
13
  options
14
14
  });
15
+ var createRole = async (body, options) => invokeFetch("roles", {
16
+ method: "post",
17
+ pathTemplate: "/api/v1/roles",
18
+ body,
19
+ contentType: "application/json",
20
+ options
21
+ });
22
+ var deleteRole = async (id, options) => invokeFetch("roles", {
23
+ method: "delete",
24
+ pathTemplate: "/api/v1/roles/{id}",
25
+ pathVariables: { id },
26
+ options
27
+ });
15
28
  var getRole = async (id, options) => invokeFetch("roles", {
16
29
  method: "get",
17
30
  pathTemplate: "/api/v1/roles/{id}",
18
31
  pathVariables: { id },
19
32
  options
20
33
  });
34
+ var patchRole = async (id, body, options) => invokeFetch("roles", {
35
+ method: "patch",
36
+ pathTemplate: "/api/v1/roles/{id}",
37
+ pathVariables: { id },
38
+ body,
39
+ contentType: "application/json",
40
+ options
41
+ });
21
42
  function clearCache() {
22
43
  return clearApiCache("roles");
23
44
  }
24
- var rolesExport = { getRoles, getRole, clearCache };
45
+ var rolesExport = { getRoles, createRole, deleteRole, getRole, patchRole, clearCache };
25
46
  var roles_default = rolesExport;
26
47
  export {
27
48
  clearCache,
49
+ createRole,
28
50
  roles_default as default,
51
+ deleteRole,
29
52
  getRole,
30
- getRoles
53
+ getRoles,
54
+ patchRole
31
55
  };
package/spaces.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -359,6 +359,8 @@ type UpdateSpaceHttpError = {
359
359
  * @throws GetSpaceAssignmentsHttpError
360
360
  */
361
361
  declare const getSpaceAssignments: (spaceId: string, query: {
362
+ /** Filters assignment for a specific assigneeid. */
363
+ assigneeId?: string;
362
364
  /** Maximum number of assignments to return. */
363
365
  limit?: number;
364
366
  /** The next page cursor. Next links make use of this. */
package/spaces.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -48,7 +48,7 @@ type DetailResponse = {
48
48
  UpdatedAt?: string;
49
49
  };
50
50
  /**
51
- * This endpoint is used to upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
51
+ * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
52
52
  *
53
53
  * @param query an object with query parameters
54
54
  * @param body an object with the body content
@@ -104,7 +104,7 @@ type DownloadTempFileHttpError = {
104
104
  status: number;
105
105
  };
106
106
  /**
107
- * This endpoint is used to retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
107
+ * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
108
108
  *
109
109
  * @param id The temporary contents ID.
110
110
  * @throws GetTempFileDetailsHttpError
@@ -132,7 +132,7 @@ type GetTempFileDetailsHttpError = {
132
132
  declare function clearCache(): void;
133
133
  interface TempContentsAPI {
134
134
  /**
135
- * This endpoint is used to upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
135
+ * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
136
136
  *
137
137
  * @param query an object with query parameters
138
138
  * @param body an object with the body content
@@ -148,7 +148,7 @@ interface TempContentsAPI {
148
148
  */
149
149
  downloadTempFile: typeof downloadTempFile;
150
150
  /**
151
- * This endpoint is used to retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
151
+ * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
152
152
  *
153
153
  * @param id The temporary contents ID.
154
154
  * @throws GetTempFileDetailsHttpError
package/temp-contents.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -62,7 +62,16 @@ type Tenant = {
62
62
  status?: "active" | "disabled" | "deleted";
63
63
  };
64
64
  type TenantCreationRequest = {
65
- /** The datacenter where the tenant is located. */
65
+ /** The datacenter where the tenant is located.
66
+ *
67
+ * Supported locations for commercial licenses:
68
+ * - `ap-northeast-1`: Japan (jp)
69
+ * - `ap-southeast-1`: Australia (ap)
70
+ * - `ap-southeast-2`: Singapore (sg)
71
+ * - `eu-central-1`: Germany (de)
72
+ * - `eu-west-1`: Ireland (eu)
73
+ * - `eu-west-2`: United Kingdom (uk)
74
+ * - `us-east-1`: United States of America (us) */
66
75
  datacenter?: string;
67
76
  /** The signed license key of the license that will be associated with the created tenant. */
68
77
  licenseKey?: string;
@@ -116,7 +125,7 @@ type TenantPatchSchema = {
116
125
  value: string | boolean;
117
126
  }[];
118
127
  /**
119
- * Creates a Tenant
128
+ * 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.
120
129
  *
121
130
  * @param body an object with the body content
122
131
  * @throws CreateTenantHttpError
@@ -149,9 +158,9 @@ type GetMyTenantHttpError = {
149
158
  status: number;
150
159
  };
151
160
  /**
152
- * Retrieve a single tenant by id.
161
+ * Retrieves a specific tenant by ID.
153
162
  *
154
- * @param tenantId The id of the tenant to retrieve
163
+ * @param tenantId The ID of the tenant to retrieve
155
164
  * @throws GetTenantHttpError
156
165
  */
157
166
  declare const getTenant: (tenantId: string, options?: ApiCallOptions) => Promise<GetTenantHttpResponse>;
@@ -166,9 +175,9 @@ type GetTenantHttpError = {
166
175
  status: number;
167
176
  };
168
177
  /**
169
- * Update a tenant by id.
178
+ * Updates properties of a specific tenant by ID.
170
179
  *
171
- * @param tenantId The id of the tenant to update
180
+ * @param tenantId The ID of the tenant to update
172
181
  * @param body an object with the body content
173
182
  * @throws PatchTenantHttpError
174
183
  */
@@ -205,7 +214,7 @@ type PatchTenantDefaultHttpError = {
205
214
  };
206
215
  type PatchTenantHttpError = PatchTenant400HttpError | PatchTenant403HttpError | PatchTenant404HttpError | PatchTenant429HttpError | PatchTenantDefaultHttpError;
207
216
  /**
208
- * Deactivates a tenant.
217
+ * 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.
209
218
  *
210
219
  * @param tenantId The id of the tenant to deactivate
211
220
  * @param body an object with the body content
@@ -223,7 +232,7 @@ type DeactivateTenantHttpError = {
223
232
  status: number;
224
233
  };
225
234
  /**
226
- * Reactivates a disabled tenant.
235
+ * 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.
227
236
  *
228
237
  * @param tenantId The id of the tenant to reactivate
229
238
  * @param body an object with the body content
@@ -246,7 +255,7 @@ type ReactivateTenantHttpError = {
246
255
  declare function clearCache(): void;
247
256
  interface TenantsAPI {
248
257
  /**
249
- * Creates a Tenant
258
+ * 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.
250
259
  *
251
260
  * @param body an object with the body content
252
261
  * @throws CreateTenantHttpError
@@ -259,22 +268,22 @@ interface TenantsAPI {
259
268
  */
260
269
  getMyTenant: typeof getMyTenant;
261
270
  /**
262
- * Retrieve a single tenant by id.
271
+ * Retrieves a specific tenant by ID.
263
272
  *
264
- * @param tenantId The id of the tenant to retrieve
273
+ * @param tenantId The ID of the tenant to retrieve
265
274
  * @throws GetTenantHttpError
266
275
  */
267
276
  getTenant: typeof getTenant;
268
277
  /**
269
- * Update a tenant by id.
278
+ * Updates properties of a specific tenant by ID.
270
279
  *
271
- * @param tenantId The id of the tenant to update
280
+ * @param tenantId The ID of the tenant to update
272
281
  * @param body an object with the body content
273
282
  * @throws PatchTenantHttpError
274
283
  */
275
284
  patchTenant: typeof patchTenant;
276
285
  /**
277
- * Deactivates a tenant.
286
+ * 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.
278
287
  *
279
288
  * @param tenantId The id of the tenant to deactivate
280
289
  * @param body an object with the body content
@@ -282,7 +291,7 @@ interface TenantsAPI {
282
291
  */
283
292
  deactivateTenant: typeof deactivateTenant;
284
293
  /**
285
- * Reactivates a disabled tenant.
294
+ * 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.
286
295
  *
287
296
  * @param tenantId The id of the tenant to reactivate
288
297
  * @param body an object with the body content
package/tenants.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.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/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.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/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -135,7 +135,7 @@ type JSONPatch = {
135
135
  /** The operation to be performed. */
136
136
  op: "replace" | "set (Deprecated)" | "unset (Deprecated)" | "add (Deprecated)" | "renew";
137
137
  /** A JSON Pointer. */
138
- path: "/name" | "/roles (Deprecated)" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status";
138
+ path: "/name" | "/roles (Deprecated)" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
139
139
  /** The value to be used for this operation. */
140
140
  value: string | boolean | unknown[] | AssignedRolesRefIDs | AssignedRolesRefNames;
141
141
  };
@@ -143,15 +143,6 @@ type JSONPatch = {
143
143
  * An array of JSON Patch documents
144
144
  */
145
145
  type JSONPatchArray = JSONPatch[];
146
- /**
147
- * @deprecated
148
- *
149
- * An object containing the metadata for the user configuration.
150
- */
151
- type Metadata = {
152
- /** List of system roles to which the user can be assigned. */
153
- valid_roles?: string[];
154
- };
155
146
  /**
156
147
  * Invitee result item
157
148
  */
@@ -184,7 +175,7 @@ type User = {
184
175
  email?: string;
185
176
  /** The unique user identifier. */
186
177
  readonly id: string;
187
- /** The number of seconds until the user invitation will expire. */
178
+ /** The Unix timestamp indicating when the invite will expire. */
188
179
  readonly inviteExpiry?: number;
189
180
  /** @deprecated
190
181
  * Deprecated. Use `lastUpdatedAt` instead. */
@@ -460,24 +451,6 @@ type GetMyUserHttpError = {
460
451
  headers: Headers;
461
452
  status: number;
462
453
  };
463
- /**
464
- * @deprecated
465
- *
466
- * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
467
- *
468
- * @throws GetUsersMetadataHttpError
469
- */
470
- declare const getUsersMetadata: (options?: ApiCallOptions) => Promise<GetUsersMetadataHttpResponse>;
471
- type GetUsersMetadataHttpResponse = {
472
- data: Metadata;
473
- headers: Headers;
474
- status: number;
475
- };
476
- type GetUsersMetadataHttpError = {
477
- data: Errors;
478
- headers: Headers;
479
- status: number;
480
- };
481
454
  /**
482
455
  * Deletes the requested user.
483
456
  *
@@ -587,14 +560,6 @@ interface UsersAPI {
587
560
  * @throws GetMyUserHttpError
588
561
  */
589
562
  getMyUser: typeof getMyUser;
590
- /**
591
- * @deprecated
592
- *
593
- * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
594
- *
595
- * @throws GetUsersMetadataHttpError
596
- */
597
- getUsersMetadata: typeof getUsersMetadata;
598
563
  /**
599
564
  * Deletes the requested user.
600
565
  *
@@ -628,4 +593,4 @@ interface UsersAPI {
628
593
  */
629
594
  declare const usersExport: UsersAPI;
630
595
 
631
- 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 GetUsersMetadataHttpError, type GetUsersMetadataHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type Metadata, 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, getUsersMetadata, inviteUsers, patchUser };
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 };