@qlik/api 2.2.0 → 2.3.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 (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,780 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/spaces.d.ts
4
-
5
- /**
6
- * The supported actions for user-created spaces.
7
- */
8
- type ActionName = "change_owner" | "create" | "read" | "update" | "delete" | "publish" | "link_environment" | "restrict";
9
- type Assignment = {
10
- /** The userId or groupId based on the type. */
11
- assigneeId: string;
12
- /** The date and time when the space was created. */
13
- readonly createdAt?: string;
14
- /** The ID of the user who created the assignment. */
15
- readonly createdBy?: string;
16
- readonly id: string;
17
- readonly links: {
18
- self: Link;
19
- space?: Link;
20
- };
21
- /** The roles assigned to a user or group. Must not be empty. */
22
- roles: RoleType[];
23
- /** The unique identifier for the space. */
24
- readonly spaceId: string;
25
- /** The unique identifier for the tenant. */
26
- readonly tenantId: string;
27
- /** The type of assignment such as user or group */
28
- type: AssignmentType;
29
- /** The date and time when the space was updated. */
30
- readonly updatedAt?: string;
31
- /** The ID of the user who updated the assignment. */
32
- readonly updatedBy?: string;
33
- };
34
- type AssignmentCreate = {
35
- /** The userId or groupId based on the type. */
36
- assigneeId: string;
37
- /** 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. */
38
- roles: RoleType[];
39
- /** The type of assignment such as user or group */
40
- type: AssignmentType;
41
- };
42
- /**
43
- * The type of assignment such as user or group
44
- */
45
- type AssignmentType = "user" | "group" | "bot";
46
- type AssignmentUpdate = {
47
- /** 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. */
48
- roles?: RoleType[];
49
- };
50
- type Assignments = {
51
- data?: Assignment[];
52
- readonly links?: {
53
- next?: Link;
54
- prev?: Link;
55
- self: Link;
56
- };
57
- readonly meta?: {
58
- /** The total number of assignments matching the current filter. */
59
- count: number;
60
- };
61
- };
62
- /**
63
- * An error object.
64
- */
65
- type Error = {
66
- /** The error code. */
67
- code: string;
68
- /** A human-readable explanation specific to the occurrence of this problem. */
69
- detail?: string;
70
- /** Additional properties relating to the error. */
71
- meta?: {
72
- /** References to the source of the error. */
73
- source?: {
74
- /** The URI query parameter that caused the error. */
75
- parameter?: string;
76
- /** A JSON pointer to the property that caused the error. */
77
- pointer?: string;
78
- };
79
- };
80
- /** Summary of the problem. */
81
- title: string;
82
- };
83
- type Errors = {
84
- /** @deprecated
85
- * The error code. */
86
- code?: string;
87
- /** @deprecated
88
- * A human-readable explanation specific to the occurrence of this problem. */
89
- detail?: string;
90
- errors?: Error[];
91
- /** @deprecated
92
- * Additional properties relating to the error. */
93
- meta?: unknown;
94
- /** @deprecated
95
- * References to the source of the error. */
96
- source?: {
97
- /** The URI query parameter that caused the error. */
98
- parameter?: string;
99
- /** A JSON pointer to the property that caused the error. */
100
- pointer?: string;
101
- };
102
- /** @deprecated
103
- * Summary of the problem. */
104
- title?: string;
105
- traceId?: string;
106
- };
107
- type Link = {
108
- /** URL that defines the resource. */
109
- href: string;
110
- };
111
- /**
112
- * Supported roles by space type:
113
- * - Shared: codeveloper, consumer, dataconsumer, facilitator, producer
114
- * - Managed: consumer, contributor, dataconsumer, facilitator, publisher, basicconsumer
115
- * - Data: consumer, dataconsumer, datapreview, facilitator, operator, producer, publisher
116
- */
117
- type RoleType = "consumer" | "contributor" | "dataconsumer" | "datapreview" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
118
- type Share = {
119
- /** The userId or groupId based on the type. */
120
- assigneeId: string;
121
- readonly createdAt?: string;
122
- /** The ID of the user who created the share. */
123
- readonly createdBy?: string;
124
- /** If the share is disabled (effective ONLY for link shares). */
125
- disabled?: boolean;
126
- readonly id: string;
127
- readonly links?: {
128
- self: Link;
129
- space?: Link;
130
- };
131
- /** The ID of the shared resource. */
132
- resourceId: string;
133
- /** The name of the shared resource. */
134
- resourceName?: string;
135
- /** The type of the shared resource. */
136
- resourceType: "app";
137
- /** The roles assigned to the assigneeId. */
138
- roles?: ShareRoleType[];
139
- readonly spaceId: string;
140
- readonly tenantId: string;
141
- type: ShareType;
142
- readonly updatedAt?: string;
143
- /** The ID of the user who updated the share. */
144
- readonly updatedBy?: string;
145
- };
146
- type ShareCreate = {
147
- /** The userId or groupId based on the type. */
148
- assigneeId: string;
149
- /** The resource id for the shared item. */
150
- resourceId: string;
151
- /** The resource type for the shared item. */
152
- resourceType: string;
153
- /** The roles assigned to the assigneeId. */
154
- roles: ShareRoleType[];
155
- type: ShareType;
156
- };
157
- type SharePatch = {
158
- /** The operation to be performed. */
159
- op: "replace";
160
- /** Field of Share to be patched (updated). */
161
- path: "/roles" | "/disabled";
162
- /** The value to be used within the operations.
163
- * - roles: The roles assigned to the assigneeId.
164
- * - disabled: To disable the share (effective ONLY for link shares). */
165
- value: string;
166
- }[];
167
- /**
168
- * The roles for the space share. Supported roles by space type:
169
- * - Shared: consumer
170
- * - Managed: basicconsumer, consumer, contributor
171
- */
172
- type ShareRoleType = "consumer" | "contributor" | "basicconsumer";
173
- type ShareType = "user" | "group" | "link";
174
- type Shares = {
175
- data?: Share[];
176
- readonly links?: {
177
- next?: Link;
178
- prev?: Link;
179
- self: Link;
180
- };
181
- readonly meta?: {
182
- /** The total number of Shares matching the current filter. */
183
- count: number;
184
- };
185
- };
186
- /**
187
- * A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
188
- */
189
- type Space = {
190
- /** The date and time when the space was created. */
191
- readonly createdAt?: string;
192
- /** The ID of the user who created the space. */
193
- readonly createdBy?: string;
194
- /** The description of the space. Personal spaces do not have a description. */
195
- description?: string;
196
- /** A unique identifier for the space, for example, 62716f4b39b865ece543cd45. */
197
- readonly id: string;
198
- readonly links: {
199
- assignments: Link;
200
- self: Link;
201
- };
202
- /** Information about the space settings. */
203
- readonly meta?: {
204
- /** The list of actions allowed by the current user in this space. */
205
- actions: ActionName[];
206
- /** The list of roles that could be assigned in this space. */
207
- assignableRoles: RoleType[];
208
- /** The list of roles assigned to the current user in this space. */
209
- roles: RoleType[];
210
- };
211
- /** The name of the space. Personal spaces do not have a name. */
212
- name: string;
213
- /** The ID for the space owner. */
214
- readonly ownerId?: string;
215
- /** The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct. */
216
- readonly tenantId: string;
217
- /** The type of space such as shared, managed, and so on. */
218
- readonly type?: "shared" | "managed" | "data";
219
- /** The date and time when the space was updated. */
220
- readonly updatedAt?: string;
221
- };
222
- type SpaceCreate = {
223
- /** The description of the space. Personal spaces do not have a description. */
224
- description?: string;
225
- /** The name of the space. Personal spaces do not have a name. */
226
- name: string;
227
- /** The type of space such as shared, managed, and so on. */
228
- type: "shared" | "managed" | "data";
229
- };
230
- type SpacePatch = {
231
- /** The operation to be performed. */
232
- op: "replace";
233
- /** Field of space to be patched (updated). */
234
- path: "/name" | "/ownerId" | "/description";
235
- /** The value to be used within the operations.
236
- * - name: The name (string) of space of maxLength 256 of pattern: ^[^\"\*\?\<\>\/\|\\\:]+$
237
- * - description: The description (string) of the space. Personal spaces do not have a description.
238
- * - ownerId: The user ID in uid format (string) of the space owner. */
239
- value: string;
240
- }[];
241
- /**
242
- * The name of the type.
243
- */
244
- type SpaceType = "shared" | "managed" | "data";
245
- /**
246
- * The distinct types of spaces (shared, managed, and so on).
247
- */
248
- type SpaceTypes = {
249
- readonly data?: SpaceType[];
250
- };
251
- type SpaceUpdate = {
252
- /** The description of the space. Personal spaces do not have a description. */
253
- description?: string;
254
- /** The name of the space. */
255
- name?: string;
256
- /** The user ID of the space owner. */
257
- ownerId?: string;
258
- };
259
- type Spaces = {
260
- data?: Space[];
261
- readonly links?: {
262
- next?: Link;
263
- prev?: Link;
264
- self: Link;
265
- };
266
- readonly meta?: {
267
- /** The total number of spaces matching the current filter. */
268
- count: number;
269
- /** The meta related to personal space when applicable. */
270
- readonly personalSpace?: {
271
- /** The list of actions allowed by the current user in this space. */
272
- actions: ActionName[];
273
- /** resource type */
274
- resourceType: string;
275
- };
276
- };
277
- };
278
- /**
279
- * Retrieves spaces that the current user has access to and match the query.
280
- *
281
- * @param query an object with query parameters
282
- * @throws GetSpacesHttpError
283
- */
284
- declare function getSpaces(query: {
285
- /** Action on space. Supports only "?action=publish". */
286
- action?: string;
287
- /** Maximum number of spaces to return. */
288
- limit?: number;
289
- /** Space name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. For example, "?name=fin" will get "finance", "Final" and "Griffin". */
290
- name?: string;
291
- /** The next page cursor. Next links make use of this. */
292
- next?: string;
293
- /** Space ownerId to filter by. For example, "?ownerId=123". */
294
- ownerId?: string;
295
- /** The previous page cursor. Previous links make use of this. */
296
- prev?: string;
297
- /** Field to sort by. Prefix with +/- to indicate asc/desc. For example, "?sort=+name" to sort ascending on Name. Supported fields are "type", "name" and "createdAt". */
298
- sort?: string;
299
- /** Type(s) of space to filter. For example, "?type=managed,shared". */
300
- type?: string;
301
- }, options?: ApiCallOptions): Promise<GetSpacesHttpResponse>;
302
- type GetSpacesHttpResponse = {
303
- data: Spaces;
304
- headers: Headers;
305
- status: 200;
306
- prev?: (options?: ApiCallOptions) => Promise<GetSpacesHttpResponse>;
307
- next?: (options?: ApiCallOptions) => Promise<GetSpacesHttpResponse>;
308
- };
309
- type GetSpacesHttpError = {
310
- data: Errors;
311
- headers: Headers;
312
- status: 400 | 401 | 500;
313
- };
314
- /**
315
- * Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.
316
- *
317
- * @param body an object with the body content
318
- * @throws CreateSpaceHttpError
319
- */
320
- declare function createSpace(body: SpaceCreate, options?: ApiCallOptions): Promise<CreateSpaceHttpResponse>;
321
- type CreateSpaceHttpResponse = {
322
- data: Space;
323
- headers: Headers;
324
- status: 201;
325
- };
326
- type CreateSpaceHttpError = {
327
- data: Errors;
328
- headers: Headers;
329
- status: 401 | 403 | 409 | 500;
330
- };
331
- /**
332
- * Gets a list of distinct space types available for use in the tenant.
333
- *
334
- * @throws GetSpaceTypesHttpError
335
- */
336
- declare function getSpaceTypes(options?: ApiCallOptions): Promise<GetSpaceTypesHttpResponse>;
337
- type GetSpaceTypesHttpResponse = {
338
- data: SpaceTypes;
339
- headers: Headers;
340
- status: 200;
341
- };
342
- type GetSpaceTypesHttpError = {
343
- data: Errors;
344
- headers: Headers;
345
- status: 401 | 500;
346
- };
347
- /**
348
- * Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content.
349
- *
350
- * @param spaceId The ID of the space to delete.
351
- * @throws DeleteSpaceHttpError
352
- */
353
- declare function deleteSpace(spaceId: string, options?: ApiCallOptions): Promise<DeleteSpaceHttpResponse>;
354
- type DeleteSpaceHttpResponse = {
355
- data: void;
356
- headers: Headers;
357
- status: 204;
358
- };
359
- type DeleteSpaceHttpError = {
360
- data: Errors;
361
- headers: Headers;
362
- status: 401 | 403 | 404 | 412 | 500;
363
- };
364
- /**
365
- * Retrieves a single space by ID.
366
- *
367
- * @param spaceId The ID of the space to retrieve.
368
- * @throws GetSpaceHttpError
369
- */
370
- declare function getSpace(spaceId: string, options?: ApiCallOptions): Promise<GetSpaceHttpResponse>;
371
- type GetSpaceHttpResponse = {
372
- data: Space;
373
- headers: Headers;
374
- status: 200;
375
- };
376
- type GetSpaceHttpError = {
377
- data: Errors;
378
- headers: Headers;
379
- status: 401 | 404 | 429 | 500;
380
- };
381
- /**
382
- * Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.
383
- *
384
- * @param spaceId The ID of the space to update.
385
- * @param body an object with the body content
386
- * @throws PatchSpaceHttpError
387
- */
388
- declare function patchSpace(spaceId: string, body: SpacePatch, options?: ApiCallOptions): Promise<PatchSpaceHttpResponse>;
389
- type PatchSpaceHttpResponse = {
390
- data: Space;
391
- headers: Headers;
392
- status: 200;
393
- };
394
- type PatchSpaceHttpError = {
395
- data: Errors;
396
- headers: Headers;
397
- status: 401 | 403 | 404 | 500;
398
- };
399
- /**
400
- * Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.
401
- *
402
- * @param spaceId The ID of the space to update.
403
- * @param body an object with the body content
404
- * @throws UpdateSpaceHttpError
405
- */
406
- declare function updateSpace(spaceId: string, body: SpaceUpdate, options?: ApiCallOptions): Promise<UpdateSpaceHttpResponse>;
407
- type UpdateSpaceHttpResponse = {
408
- data: Space;
409
- headers: Headers;
410
- status: 200;
411
- };
412
- type UpdateSpaceHttpError = {
413
- data: Errors;
414
- headers: Headers;
415
- status: 401 | 403 | 404 | 500;
416
- };
417
- /**
418
- * 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.
419
- *
420
- * @param spaceId The ID of the space of the assignment.
421
- * @param query an object with query parameters
422
- * @throws GetSpaceAssignmentsHttpError
423
- */
424
- declare function getSpaceAssignments(spaceId: string, query: {
425
- /** Filters assignment for a specific assigneeid. */
426
- assigneeId?: string;
427
- /** Maximum number of assignments to return. */
428
- limit?: number;
429
- /** The next page cursor. Next links make use of this. */
430
- next?: string;
431
- /** The previous page cursor. Previous links make use of this. */
432
- prev?: string;
433
- /** The type of assignment. Supported values are user or group. */
434
- type?: AssignmentType;
435
- }, options?: ApiCallOptions): Promise<GetSpaceAssignmentsHttpResponse>;
436
- type GetSpaceAssignmentsHttpResponse = {
437
- data: Assignments;
438
- headers: Headers;
439
- status: 200;
440
- prev?: (options?: ApiCallOptions) => Promise<GetSpaceAssignmentsHttpResponse>;
441
- next?: (options?: ApiCallOptions) => Promise<GetSpaceAssignmentsHttpResponse>;
442
- };
443
- type GetSpaceAssignmentsHttpError = {
444
- data: Errors;
445
- headers: Headers;
446
- status: 401 | 403 | 404 | 500;
447
- };
448
- /**
449
- * 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.
450
- *
451
- * @param spaceId The ID of the space of the assignment.
452
- * @param body an object with the body content
453
- * @throws CreateSpaceAssignmentHttpError
454
- */
455
- declare function createSpaceAssignment(spaceId: string, body: AssignmentCreate, options?: ApiCallOptions): Promise<CreateSpaceAssignmentHttpResponse>;
456
- type CreateSpaceAssignmentHttpResponse = {
457
- data: Assignment;
458
- headers: Headers;
459
- status: 201;
460
- };
461
- type CreateSpaceAssignmentHttpError = {
462
- data: Errors;
463
- headers: Headers;
464
- status: 401 | 403 | 404 | 409 | 500;
465
- };
466
- /**
467
- * Deletes an assignment.
468
- *
469
- * @param spaceId The ID of the space of the assignment.
470
- * @param assignmentId The ID of the assignment to delete.
471
- * @throws DeleteSpaceAssignmentHttpError
472
- */
473
- declare function deleteSpaceAssignment(spaceId: string, assignmentId: string, options?: ApiCallOptions): Promise<DeleteSpaceAssignmentHttpResponse>;
474
- type DeleteSpaceAssignmentHttpResponse = {
475
- data: void;
476
- headers: Headers;
477
- status: 204;
478
- };
479
- type DeleteSpaceAssignmentHttpError = {
480
- data: Errors;
481
- headers: Headers;
482
- status: 401 | 403 | 404 | 500;
483
- };
484
- /**
485
- * 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.
486
- *
487
- * @param spaceId The ID of the space of the assignment.
488
- * @param assignmentId The ID of the assignment to retrieve.
489
- * @throws GetSpaceAssignmentHttpError
490
- */
491
- declare function getSpaceAssignment(spaceId: string, assignmentId: string, options?: ApiCallOptions): Promise<GetSpaceAssignmentHttpResponse>;
492
- type GetSpaceAssignmentHttpResponse = {
493
- data: Assignment;
494
- headers: Headers;
495
- status: 200;
496
- };
497
- type GetSpaceAssignmentHttpError = {
498
- data: Errors;
499
- headers: Headers;
500
- status: 401 | 403 | 404 | 500;
501
- };
502
- /**
503
- * 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.
504
- *
505
- * @param spaceId The ID of the space of the assignment.
506
- * @param assignmentId The ID of the assignment to update.
507
- * @param body an object with the body content
508
- * @throws UpdateSpaceAssignmentHttpError
509
- */
510
- declare function updateSpaceAssignment(spaceId: string, assignmentId: string, body: AssignmentUpdate, options?: ApiCallOptions): Promise<UpdateSpaceAssignmentHttpResponse>;
511
- type UpdateSpaceAssignmentHttpResponse = {
512
- data: Assignment;
513
- headers: Headers;
514
- status: 200;
515
- };
516
- type UpdateSpaceAssignmentHttpError = {
517
- data: Errors;
518
- headers: Headers;
519
- status: 401 | 403 | 404 | 500;
520
- };
521
- /**
522
- * Retrieves the shares of the space matching the query.
523
- *
524
- * @param spaceId The ID of the space containing the shares.
525
- * @param query an object with query parameters
526
- * @throws GetSpaceSharesHttpError
527
- */
528
- declare function getSpaceShares(spaceId: string, query: {
529
- /** The ID of the group to which the resource is shared. */
530
- groupId?: string;
531
- /** Maximum number of shares to return. */
532
- limit?: number;
533
- /** The name of the shared resource. */
534
- name?: string;
535
- /** The next page cursor. Next links make use of this. */
536
- next?: string;
537
- /** The previous page cursor. Previous links make use of this. */
538
- prev?: string;
539
- /** The ID of the shared resource. */
540
- resourceId?: string;
541
- /** The type of the shared resource. */
542
- resourceType?: string;
543
- /** The type of share. `user` shares assign to a specific user, `group` shares assign to a specific group, and `link` shares provide anonymous access to a resource. */
544
- type?: ShareType;
545
- /** The ID of the user to which the resource is shared. */
546
- userId?: string;
547
- }, options?: ApiCallOptions): Promise<GetSpaceSharesHttpResponse>;
548
- type GetSpaceSharesHttpResponse = {
549
- data: Shares;
550
- headers: Headers;
551
- status: 200;
552
- prev?: (options?: ApiCallOptions) => Promise<GetSpaceSharesHttpResponse>;
553
- next?: (options?: ApiCallOptions) => Promise<GetSpaceSharesHttpResponse>;
554
- };
555
- type GetSpaceSharesHttpError = {
556
- data: Errors;
557
- headers: Headers;
558
- status: 401 | 403 | 404 | 500;
559
- };
560
- /**
561
- * Create a space share
562
- *
563
- * @param spaceId The ID of the space of the share.
564
- * @param body an object with the body content
565
- * @throws CreateSpaceShareHttpError
566
- */
567
- declare function createSpaceShare(spaceId: string, body: ShareCreate, options?: ApiCallOptions): Promise<CreateSpaceShareHttpResponse>;
568
- type CreateSpaceShareHttpResponse = {
569
- data: Share;
570
- headers: Headers;
571
- status: 201;
572
- };
573
- type CreateSpaceShareHttpError = {
574
- data: Errors;
575
- headers: Headers;
576
- status: 401 | 403 | 404 | 409 | 500;
577
- };
578
- /**
579
- * Deletes a space share.
580
- *
581
- * @param spaceId The ID of the space to which the share belongs.
582
- * @param shareId The ID of the share to delete.
583
- * @throws DeleteSpaceShareHttpError
584
- */
585
- declare function deleteSpaceShare(spaceId: string, shareId: string, options?: ApiCallOptions): Promise<DeleteSpaceShareHttpResponse>;
586
- type DeleteSpaceShareHttpResponse = {
587
- data: void;
588
- headers: Headers;
589
- status: 204;
590
- };
591
- type DeleteSpaceShareHttpError = {
592
- data: Errors;
593
- headers: Headers;
594
- status: 401 | 403 | 404 | 500;
595
- };
596
- /**
597
- * Retrieves a single space share by ID.
598
- *
599
- * @param spaceId The ID of the space to which the share belongs.
600
- * @param shareId The ID of the share to retrieve.
601
- * @throws GetSpaceShareHttpError
602
- */
603
- declare function getSpaceShare(spaceId: string, shareId: string, options?: ApiCallOptions): Promise<GetSpaceShareHttpResponse>;
604
- type GetSpaceShareHttpResponse = {
605
- data: Share;
606
- headers: Headers;
607
- status: 200;
608
- };
609
- type GetSpaceShareHttpError = {
610
- data: Errors;
611
- headers: Headers;
612
- status: 401 | 403 | 404 | 500;
613
- };
614
- /**
615
- * Updates properties of a space share (roles, and disabled state for link shares).
616
- *
617
- * @param spaceId The ID of the space to which the share belongs.
618
- * @param shareId The ID of the share to update.
619
- * @param body an object with the body content
620
- * @throws PatchShareHttpError
621
- */
622
- declare function patchShare(spaceId: string, shareId: string, body: SharePatch, options?: ApiCallOptions): Promise<PatchShareHttpResponse>;
623
- type PatchShareHttpResponse = {
624
- data: Share;
625
- headers: Headers;
626
- status: 200;
627
- };
628
- type PatchShareHttpError = {
629
- data: Errors;
630
- headers: Headers;
631
- status: 401 | 403 | 404 | 500;
632
- };
633
- /**
634
- * Clears the cache for spaces api requests.
635
- */
636
- declare function clearCache(): void;
637
- type SpacesAPI = {
638
- /**
639
- * Retrieves spaces that the current user has access to and match the query.
640
- *
641
- * @param query an object with query parameters
642
- * @throws GetSpacesHttpError
643
- */
644
- getSpaces: typeof getSpaces;
645
- /**
646
- * Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.
647
- *
648
- * @param body an object with the body content
649
- * @throws CreateSpaceHttpError
650
- */
651
- createSpace: typeof createSpace;
652
- /**
653
- * Gets a list of distinct space types available for use in the tenant.
654
- *
655
- * @throws GetSpaceTypesHttpError
656
- */
657
- getSpaceTypes: typeof getSpaceTypes;
658
- /**
659
- * Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content.
660
- *
661
- * @param spaceId The ID of the space to delete.
662
- * @throws DeleteSpaceHttpError
663
- */
664
- deleteSpace: typeof deleteSpace;
665
- /**
666
- * Retrieves a single space by ID.
667
- *
668
- * @param spaceId The ID of the space to retrieve.
669
- * @throws GetSpaceHttpError
670
- */
671
- getSpace: typeof getSpace;
672
- /**
673
- * Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.
674
- *
675
- * @param spaceId The ID of the space to update.
676
- * @param body an object with the body content
677
- * @throws PatchSpaceHttpError
678
- */
679
- patchSpace: typeof patchSpace;
680
- /**
681
- * Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.
682
- *
683
- * @param spaceId The ID of the space to update.
684
- * @param body an object with the body content
685
- * @throws UpdateSpaceHttpError
686
- */
687
- updateSpace: typeof updateSpace;
688
- /**
689
- * 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.
690
- *
691
- * @param spaceId The ID of the space of the assignment.
692
- * @param query an object with query parameters
693
- * @throws GetSpaceAssignmentsHttpError
694
- */
695
- getSpaceAssignments: typeof getSpaceAssignments;
696
- /**
697
- * 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.
698
- *
699
- * @param spaceId The ID of the space of the assignment.
700
- * @param body an object with the body content
701
- * @throws CreateSpaceAssignmentHttpError
702
- */
703
- createSpaceAssignment: typeof createSpaceAssignment;
704
- /**
705
- * Deletes an assignment.
706
- *
707
- * @param spaceId The ID of the space of the assignment.
708
- * @param assignmentId The ID of the assignment to delete.
709
- * @throws DeleteSpaceAssignmentHttpError
710
- */
711
- deleteSpaceAssignment: typeof deleteSpaceAssignment;
712
- /**
713
- * 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.
714
- *
715
- * @param spaceId The ID of the space of the assignment.
716
- * @param assignmentId The ID of the assignment to retrieve.
717
- * @throws GetSpaceAssignmentHttpError
718
- */
719
- getSpaceAssignment: typeof getSpaceAssignment;
720
- /**
721
- * 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.
722
- *
723
- * @param spaceId The ID of the space of the assignment.
724
- * @param assignmentId The ID of the assignment to update.
725
- * @param body an object with the body content
726
- * @throws UpdateSpaceAssignmentHttpError
727
- */
728
- updateSpaceAssignment: typeof updateSpaceAssignment;
729
- /**
730
- * Retrieves the shares of the space matching the query.
731
- *
732
- * @param spaceId The ID of the space containing the shares.
733
- * @param query an object with query parameters
734
- * @throws GetSpaceSharesHttpError
735
- */
736
- getSpaceShares: typeof getSpaceShares;
737
- /**
738
- * Create a space share
739
- *
740
- * @param spaceId The ID of the space of the share.
741
- * @param body an object with the body content
742
- * @throws CreateSpaceShareHttpError
743
- */
744
- createSpaceShare: typeof createSpaceShare;
745
- /**
746
- * Deletes a space share.
747
- *
748
- * @param spaceId The ID of the space to which the share belongs.
749
- * @param shareId The ID of the share to delete.
750
- * @throws DeleteSpaceShareHttpError
751
- */
752
- deleteSpaceShare: typeof deleteSpaceShare;
753
- /**
754
- * Retrieves a single space share by ID.
755
- *
756
- * @param spaceId The ID of the space to which the share belongs.
757
- * @param shareId The ID of the share to retrieve.
758
- * @throws GetSpaceShareHttpError
759
- */
760
- getSpaceShare: typeof getSpaceShare;
761
- /**
762
- * Updates properties of a space share (roles, and disabled state for link shares).
763
- *
764
- * @param spaceId The ID of the space to which the share belongs.
765
- * @param shareId The ID of the share to update.
766
- * @param body an object with the body content
767
- * @throws PatchShareHttpError
768
- */
769
- patchShare: typeof patchShare;
770
- /**
771
- * Clears the cache for spaces api requests.
772
- */
773
- clearCache: typeof clearCache;
774
- };
775
- /**
776
- * Functions for the spaces api
777
- */
778
- declare const spacesExport: SpacesAPI;
779
- //#endregion
780
- export { Spaces as $, GetSpaceSharesHttpResponse as A, RoleType as B, GetSpaceAssignmentsHttpError as C, updateSpaceAssignment as Ct, GetSpaceShareHttpError as D, GetSpaceHttpResponse as E, Link as F, ShareType as G, ShareCreate as H, PatchShareHttpError as I, SpaceCreate as J, Shares as K, PatchShareHttpResponse as L, GetSpaceTypesHttpResponse as M, GetSpacesHttpError as N, GetSpaceShareHttpResponse as O, GetSpacesHttpResponse as P, SpaceUpdate as Q, PatchSpaceHttpError as R, GetSpaceAssignmentHttpResponse as S, updateSpace as St, GetSpaceHttpError as T, SharePatch as U, Share as V, ShareRoleType as W, SpaceType as X, SpacePatch as Y, SpaceTypes as Z, DeleteSpaceShareHttpError as _, getSpaceTypes as _t, AssignmentUpdate as a, clearCache as at, Errors as b, patchSpace as bt, CreateSpaceAssignmentHttpResponse as c, createSpaceShare as ct, CreateSpaceShareHttpError as d, deleteSpaceShare as dt, SpacesAPI as et, CreateSpaceShareHttpResponse as f, getSpace as ft, DeleteSpaceHttpResponse as g, getSpaceShares as gt, DeleteSpaceHttpError as h, getSpaceShare as ht, AssignmentType as i, UpdateSpaceHttpResponse as it, GetSpaceTypesHttpError as j, GetSpaceSharesHttpError as k, CreateSpaceHttpError as l, deleteSpace as lt, DeleteSpaceAssignmentHttpResponse as m, getSpaceAssignments as mt, Assignment as n, UpdateSpaceAssignmentHttpResponse as nt, Assignments as o, createSpace as ot, DeleteSpaceAssignmentHttpError as p, getSpaceAssignment as pt, Space as q, AssignmentCreate as r, UpdateSpaceHttpError as rt, CreateSpaceAssignmentHttpError as s, createSpaceAssignment as st, ActionName as t, UpdateSpaceAssignmentHttpError as tt, CreateSpaceHttpResponse as u, deleteSpaceAssignment as ut, DeleteSpaceShareHttpResponse as v, getSpaces as vt, GetSpaceAssignmentsHttpResponse as w, GetSpaceAssignmentHttpError as x, spacesExport as xt, Error as y, patchShare as yt, PatchSpaceHttpResponse as z };