@qlik/api 1.23.0 → 1.25.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 +1 -1
  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 +1 -1
  11. package/brands.js +2 -2
  12. package/chunks/{E5TLRYTH.js → 3DYV7KOJ.js} +2 -2
  13. package/chunks/{CUC5USM5.js → 6DEESTGF.js} +2 -2
  14. package/chunks/{3REGOC54.js → 6QRR5VUM.js} +2 -2
  15. package/chunks/7BDAXGID.js +116 -0
  16. package/chunks/{3W4PFUMC.js → BL5PJM4B.js} +1 -1
  17. package/chunks/{3KD5W26Z.js → CZC7KEJN.js} +3 -3
  18. package/chunks/{OCV75U5H.js → I5UOE4ZZ.js} +81 -77
  19. package/chunks/{UJV2QU2J.js → N3ZFICDU.js} +3 -3
  20. package/chunks/{VXEOAWM6.js → OIQ5ELGS.js} +1 -1
  21. package/chunks/{SMQGR3VM.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 +1 -1
  30. package/data-connections.js +2 -2
  31. package/data-credentials.d.ts +1 -1
  32. package/data-credentials.js +2 -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 +3 -3
  41. package/groups.js +2 -2
  42. package/identity-providers.d.ts +1 -1
  43. package/identity-providers.js +2 -2
  44. package/index.d.ts +11 -4
  45. package/index.js +89 -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 +3 -3
  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 +35 -2
  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 +5 -3
  63. package/reports.js +2 -2
  64. package/roles.d.ts +98 -4
  65. package/roles.js +28 -4
  66. package/spaces.d.ts +23 -23
  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 +1 -1
  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 +37 -61
  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/quotas.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/quotas.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './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/reload-tasks.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.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 './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/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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
  /**
@@ -367,13 +367,15 @@ type ReportRequest = {
367
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";
368
368
  };
369
369
  type ReportStatus = {
370
- /** Present when status is failed. */
370
+ /** @deprecated
371
+ * Present when status is failed. Deprecated. Use /reports/{id}/outputs instead. */
371
372
  reasons?: Reason[];
372
373
  /** Errors occured during report generation. */
373
374
  requestErrors?: ExportErrors;
374
375
  /** Count how many times the resolution of this report was attempted. */
375
376
  resolutionAttempts?: number;
376
- /** Present when the status is "done". */
377
+ /** @deprecated
378
+ * Present when the status is "done". Deprecated. Use /reports/{id}/outputs instead. */
377
379
  results?: Result[];
378
380
  /** Status of the requested report. */
379
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/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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,10 +1,10 @@
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
  /**
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/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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
  /**
package/tenants.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.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