@qlik/api 2.2.0 → 2.3.1

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 (232) 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-XusKk8IA.js +32 -0
  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-2VSXImC9.js} +498 -146
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.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 +5 -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-Cle0_tmz.js +0 -32
  163. package/chunks/auth-D11iO7ZV.js +0 -65
  164. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  165. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  166. package/chunks/automations-BGy83EBO.d.ts +0 -797
  167. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  168. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  169. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  170. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  171. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  172. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  173. package/chunks/consumption-DerFk437.d.ts +0 -182
  174. package/chunks/core-DQXNZdnf.d.ts +0 -12
  175. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  176. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  177. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  178. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  179. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  180. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  181. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  182. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  183. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  184. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  185. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  186. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  187. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  188. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  189. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  190. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  191. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  192. package/chunks/groups-C86-UG7S.d.ts +0 -511
  193. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  194. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  195. package/chunks/interceptors-DTYm37AU.js +0 -104
  196. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  197. package/chunks/ip-policies-DXlf172B.js +0 -108
  198. package/chunks/items-C-jzqvFW.d.ts +0 -536
  199. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  200. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  201. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  202. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  203. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  204. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  205. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  206. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  207. package/chunks/qix-CYQsLyGQ.js +0 -40
  208. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  209. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  210. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  211. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  212. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  213. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  214. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  215. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  216. package/chunks/spaces-BK823t-b.d.ts +0 -780
  217. package/chunks/tasks-COKDfShO.d.ts +0 -564
  218. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  219. package/chunks/tenants-Bhn86519.d.ts +0 -361
  220. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  221. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  222. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  223. package/chunks/users-BSOBU_fg.d.ts +0 -675
  224. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  225. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  226. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  227. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  228. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  229. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  230. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  231. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  232. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
package/items.d.ts CHANGED
@@ -1,4 +1,537 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { A as ItemsResourceSizeResponseBody, B as SpaceTypeEnum, C as ItemTagResponseBody, D as ItemsLinksResponseBody, E as ItemsAPI, F as Link, G as getItem, H as UpdateItemHttpResponse, I as Meta, J as getItemsSettings, K as getItemCollections, L as PatchItemsSettingsHttpError, M as ItemsSettingsPatch, N as ItemsSettingsResponseBody, O as ItemsListItemCollectionsResponseBody, P as ItemsUpdateItemRequestBody, Q as updateItem, R as PatchItemsSettingsHttpResponse, S as ItemResultResponseBody, T as ItemViewsWeeksResponseBody, U as clearCache, V as UpdateItemHttpError, W as deleteItem, X as itemsExport, Y as getPublishedItems, Z as patchItemsSettings, _ as GetPublishedItemsHttpError, a as CollectionsLinksResponseBody, b as ItemMetaResponseBody, c as ErrorResponseBody, d as GetItemHttpError, f as GetItemHttpResponse, g as GetItemsSettingsHttpResponse, h as GetItemsSettingsHttpError, i as CollectionTypes, j as ItemsResultResponseBody, k as ItemsListItemsResponseBody, l as GetItemCollectionsHttpError, m as GetItemsHttpResponse, n as CollectionMetaResponseBody, o as DeleteItemHttpError, p as GetItemsHttpError, q as getItems, r as CollectionResultResponseBody, s as DeleteItemHttpResponse, t as CollectionLinksResponseBody, u as GetItemCollectionsHttpResponse, v as GetPublishedItemsHttpResponse, w as ItemViewsResponseBody, x as ItemResourceTypeEnum, y as ItemLinksResponseBody, z as ServiceError } from "./chunks/items-C-jzqvFW.js";
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/items.d.ts
5
+ type CollectionTypes = "private" | "public" | "publicgoverned";
6
+ type ErrorResponseBody = {
7
+ errors?: ServiceError[];
8
+ };
9
+ /**
10
+ * ListItemCollectionsResponseBody result type
11
+ */
12
+ type ItemsListItemCollectionsResponseBody = {
13
+ data: CollectionResultResponseBody[];
14
+ links: CollectionsLinksResponseBody;
15
+ };
16
+ /**
17
+ * ListItemsResponseBody result type
18
+ */
19
+ type ItemsListItemsResponseBody = {
20
+ data: ItemResultResponseBody[];
21
+ links: ItemsLinksResponseBody;
22
+ };
23
+ type ItemsSettingsPatch = {
24
+ /** The operation to be performed. Only "replace" is supported. */
25
+ op: "replace";
26
+ /** Field of Settings to be patched (updated). */
27
+ path: "/usageMetricsEnabled";
28
+ /** The value to be used within the operations. */
29
+ value: boolean;
30
+ }[];
31
+ type ItemsSettingsResponseBody = {
32
+ /** Decides if the usage metrics will be shown in the hub UI. */
33
+ usageMetricsEnabled: boolean;
34
+ };
35
+ type ItemsUpdateItemRequestBody = {
36
+ description?: string;
37
+ name?: string;
38
+ resourceAttributes?: unknown;
39
+ resourceCustomAttributes?: unknown;
40
+ /** The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
41
+ resourceId?: string;
42
+ /** The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
43
+ resourceLink?: string;
44
+ /** Optional field defining the item's subtype, if any. */
45
+ resourceSubType?: string;
46
+ /** The case-sensitive string defining the item's type. */
47
+ resourceType: ItemResourceTypeEnum;
48
+ /** The RFC3339 datetime when the resource that the item references was last updated. */
49
+ resourceUpdatedAt?: string;
50
+ /** The space's unique identifier. */
51
+ spaceId?: string;
52
+ /** The item thumbnail's unique identifier. This is optional for internal resources. */
53
+ thumbnailId?: string;
54
+ };
55
+ type Link = {
56
+ href?: string;
57
+ };
58
+ type ServiceError = {
59
+ /** Code is a unique identifier for this error class. */
60
+ code?: string;
61
+ /** Detail is a human-readable explanation specific to this occurrence of the problem. */
62
+ detail?: string;
63
+ meta?: Meta;
64
+ /** Title is the name of this class of errors. */
65
+ title?: string;
66
+ };
67
+ type CollectionLinksResponseBody = {
68
+ items?: Link;
69
+ self?: Link;
70
+ };
71
+ /**
72
+ * Collection metadata and computed fields.
73
+ */
74
+ type CollectionMetaResponseBody = {
75
+ /** Multiple items. */
76
+ items?: ItemsResultResponseBody;
77
+ };
78
+ /**
79
+ * A collection.
80
+ */
81
+ type CollectionResultResponseBody = {
82
+ /** The RFC3339 datetime when the collection was created. */
83
+ createdAt: string;
84
+ /** The ID of the user who created the collection. This property is only populated if the JWT contains a userId. */
85
+ creatorId?: string;
86
+ description?: string;
87
+ /** States if a collection has reached its items limit or not */
88
+ full?: boolean;
89
+ /** The collection's unique identifier. */
90
+ id: string;
91
+ /** The number of items that have been added to the collection that the user has access to. */
92
+ itemCount: number;
93
+ links: CollectionLinksResponseBody;
94
+ /** Collection metadata and computed fields. */
95
+ meta?: CollectionMetaResponseBody;
96
+ name: string;
97
+ /** The ID of the tenant that owns the collection. This property is populated by using JWT. */
98
+ tenantId: string;
99
+ type: "private" | "public" | "favorite" | "publicgoverned";
100
+ /** The RFC3339 datetime when the collection was last updated. */
101
+ updatedAt: string;
102
+ /** The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId. */
103
+ updaterId?: string;
104
+ };
105
+ type CollectionsLinksResponseBody = {
106
+ item?: Link;
107
+ next?: Link;
108
+ prev?: Link;
109
+ self?: Link;
110
+ };
111
+ type ItemLinksResponseBody = {
112
+ collections?: Link;
113
+ open?: Link;
114
+ qvPlugin?: Link;
115
+ self?: Link;
116
+ thumbnail?: Link;
117
+ };
118
+ /**
119
+ * Item metadata and computed fields.
120
+ */
121
+ type ItemMetaResponseBody = {
122
+ /** The actions that the user can perform on the item. */
123
+ actions: string[];
124
+ /** An array of collections that the item is part of. */
125
+ collections: ItemTagResponseBody[];
126
+ /** The flag that indicates if item is in the user's favorites collection. */
127
+ isFavorited: boolean;
128
+ /** An array of tags that the item is part of. */
129
+ tags: ItemTagResponseBody[];
130
+ };
131
+ /**
132
+ * The case-sensitive string defining the item's type.
133
+ */
134
+ type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment" | "assistant" | "dataproduct" | "dataqualityrule" | "glossary" | "knowledgebase" | "script";
135
+ /**
136
+ * An item.
137
+ */
138
+ type ItemResultResponseBody = {
139
+ /** The actions that the user can perform on the item. */
140
+ actions: string[];
141
+ /** The ID of the collections that the item has been added to. */
142
+ collectionIds: string[];
143
+ /** The RFC3339 datetime when the item was created. */
144
+ createdAt: string;
145
+ /** The ID of the user who created the item. This is only populated if the JWT contains a userId. */
146
+ creatorId?: string;
147
+ description?: string;
148
+ /** The item's unique identifier. */
149
+ id: string;
150
+ /** The flag that indicates if item is in the user's favorites collection. */
151
+ isFavorited: boolean;
152
+ itemViews?: ItemViewsResponseBody;
153
+ links: ItemLinksResponseBody;
154
+ /** Item metadata and computed fields. */
155
+ meta: ItemMetaResponseBody;
156
+ name: string;
157
+ /** The ID of the user who owns the item. */
158
+ ownerId?: string;
159
+ resourceAttributes: unknown;
160
+ /** The RFC3339 datetime when the resource that the item references was created. */
161
+ resourceCreatedAt: string;
162
+ resourceCustomAttributes: unknown;
163
+ /** The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
164
+ resourceId?: string;
165
+ /** The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
166
+ resourceLink?: string;
167
+ /** The RFC3339 datetime when the resource last reload ended. */
168
+ resourceReloadEndTime?: string;
169
+ /** If the resource last reload was successful or not. */
170
+ resourceReloadStatus?: string;
171
+ resourceSize?: ItemsResourceSizeResponseBody;
172
+ /** Optional field defining the item's subtype, if any. */
173
+ resourceSubType?: string;
174
+ /** The case-sensitive string defining the item's type. */
175
+ resourceType: ItemResourceTypeEnum;
176
+ /** The RFC3339 datetime when the resource that the item references was last updated. */
177
+ resourceUpdatedAt: string;
178
+ /** The space's unique identifier. */
179
+ spaceId?: string;
180
+ /** The ID of the tenant that owns the item. This is populated using the JWT. */
181
+ tenantId: string;
182
+ /** The item thumbnail's unique identifier. This is optional for internal resources. */
183
+ thumbnailId?: string;
184
+ /** The RFC3339 datetime when the item was last updated. */
185
+ updatedAt: string;
186
+ /** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
187
+ updaterId?: string;
188
+ };
189
+ /**
190
+ * Holds basic information about a tag or collection.
191
+ */
192
+ type ItemTagResponseBody = {
193
+ /** The ID of the tag/collection. */
194
+ id: string;
195
+ /** The name of the tag/collection. */
196
+ name: string;
197
+ };
198
+ type ItemViewsResponseBody = {
199
+ /** Total number of views the resource got during the last 28 days. */
200
+ total?: number;
201
+ /** Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks. */
202
+ trend?: number;
203
+ /** Number of unique users who viewed the resource during the last 28 days. */
204
+ unique?: number;
205
+ /** Number of apps this dataset is used in (datasets only). */
206
+ usedBy?: number;
207
+ week?: ItemViewsWeeksResponseBody[];
208
+ };
209
+ type ItemViewsWeeksResponseBody = {
210
+ /** The RFC3339 datetime representing the start of the referenced week. */
211
+ start?: string;
212
+ /** Total number of views the resource got during the referenced week. */
213
+ total?: number;
214
+ /** Number of unique users who viewed the resource during the referenced week. */
215
+ unique?: number;
216
+ };
217
+ type ItemsLinksResponseBody = {
218
+ collection?: Link;
219
+ next?: Link;
220
+ prev?: Link;
221
+ self?: Link;
222
+ };
223
+ type ItemsResourceSizeResponseBody = {
224
+ /** Size of the app on disk in bytes. */
225
+ appFile?: number;
226
+ /** Size of the app in memory in bytes. */
227
+ appMemory?: number;
228
+ };
229
+ /**
230
+ * Multiple items.
231
+ */
232
+ type ItemsResultResponseBody = {
233
+ data: ItemResultResponseBody[];
234
+ links: ItemsLinksResponseBody;
235
+ };
236
+ type Meta = {
237
+ /** Further explanation of the error */
238
+ explain?: unknown;
239
+ /** Is the error a server-side fault? */
240
+ fault?: boolean;
241
+ /** Is the error temporary? */
242
+ temporary?: boolean;
243
+ /** Is the error a timeout? */
244
+ timeout?: boolean;
245
+ };
246
+ /**
247
+ * The case-sensitive string defining the space type.
248
+ */
249
+ type SpaceTypeEnum = "shared" | "managed" | "personal" | "data";
250
+ /**
251
+ * Lists items that the user has access to.
252
+ *
253
+ * @param query an object with query parameters
254
+ * @throws GetItemsHttpError
255
+ */
256
+ declare function getItems(query: {
257
+ /** The collection's unique identifier. Used to filter for items with a specific tag (collection type `public`), or collection. */
258
+ collectionId?: string;
259
+ /** User's unique identifier. */
260
+ createdByUserId?: string;
261
+ /** The item's unique identifier. */
262
+ id?: string;
263
+ /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
264
+ limit?: number;
265
+ /** The case-insensitive string used to search for a resource by name. */
266
+ name?: string;
267
+ /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
268
+ next?: string;
269
+ /** If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time). */
270
+ noActions?: boolean;
271
+ /** User's unique identifier. */
272
+ notCreatedByUserId?: string;
273
+ /** Owner identifier. */
274
+ notOwnerId?: string;
275
+ /** Owner identifier. */
276
+ ownerId?: string;
277
+ /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
278
+ prev?: string;
279
+ /** The case-insensitive string used to search for a resource by name or description. */
280
+ query?: string;
281
+ /** The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
282
+ resourceId?: string;
283
+ /** The case-sensitive strings used to search for an item by resourceIds. The maximum number of resourceIds it supports is 100. If resourceIds is provided, then resourceType must be provided. For example '?resourceIds=appId1,appId2' */
284
+ resourceIds?: string;
285
+ /** The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
286
+ resourceLink?: string;
287
+ /** the case-sensitive string used to filter items by resourceSubType(s). For example '?resourceSubType=chart-monitoring,qix-df,qvd'. Will return a 400 error if used in conjuction with the square bracket syntax for resourceSubType filtering in the 'resourceType' query parameter. */
288
+ resourceSubType?: string;
289
+ /** The case-sensitive string used to filter items by resourceType(s). For example '?resourceType=app,qvapp'. Additionally, a optional resourceSubType filter can be added to each resourceType. For example '?resourceType=app[qvd,chart-monitoring],qvapp'. An trailing comma can be used to include the empty resourceSubType, e.g. '?resourceType=app[qvd,chart-monitoring,]', or, to include only empty resourceSubTypes, '?resourceType=app[]' This syntax replaces the 'resourceSubType' query param, and using both in the same query will result in a 400 error. */
290
+ resourceType?: ItemResourceTypeEnum;
291
+ /** @deprecated
292
+ * Whether or not to return items in a shared space. */
293
+ shared?: boolean;
294
+ /** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, recentlyUsed and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
295
+ sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt" | "+recentlyUsed" | "-recentlyUsed";
296
+ /** The space's unique identifier (supports \'personal\' as spaceId). */
297
+ spaceId?: string;
298
+ /** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */
299
+ spaceType?: SpaceTypeEnum;
300
+ }, options?: ApiCallOptions): Promise<GetItemsHttpResponse>;
301
+ type GetItemsHttpResponse = {
302
+ data: ItemsListItemsResponseBody;
303
+ headers: Headers;
304
+ status: 200;
305
+ prev?: (options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
306
+ next?: (options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
307
+ };
308
+ type GetItemsHttpError = {
309
+ data: ErrorResponseBody;
310
+ headers: Headers;
311
+ status: 400 | 401 | 404 | 500;
312
+ };
313
+ /**
314
+ * Finds and returns the items service settings for the current tenant. Currently used to enable or disable usage metrics in the tenant.
315
+ *
316
+ * @throws GetItemsSettingsHttpError
317
+ */
318
+ declare function getItemsSettings(options?: ApiCallOptions): Promise<GetItemsSettingsHttpResponse>;
319
+ type GetItemsSettingsHttpResponse = {
320
+ data: ItemsSettingsResponseBody;
321
+ headers: Headers;
322
+ status: 200;
323
+ };
324
+ type GetItemsSettingsHttpError = {
325
+ data: ErrorResponseBody;
326
+ headers: Headers;
327
+ status: 400 | 401 | 500;
328
+ };
329
+ /**
330
+ * Updates the settings provided in the patch body. Currently used to enable or disable usage metrics in the tenant.
331
+ *
332
+ * @param body an object with the body content
333
+ * @throws PatchItemsSettingsHttpError
334
+ */
335
+ declare function patchItemsSettings(body: ItemsSettingsPatch, options?: ApiCallOptions): Promise<PatchItemsSettingsHttpResponse>;
336
+ type PatchItemsSettingsHttpResponse = {
337
+ data: ItemsSettingsResponseBody;
338
+ headers: Headers;
339
+ status: 200;
340
+ };
341
+ type PatchItemsSettingsHttpError = {
342
+ data: ErrorResponseBody;
343
+ headers: Headers;
344
+ status: 400 | 401 | 403 | 500;
345
+ };
346
+ /**
347
+ * Deletes an item and removes the item from all collections.
348
+ *
349
+ * @param itemId The item's unique identifier.
350
+ * @throws DeleteItemHttpError
351
+ */
352
+ declare function deleteItem(itemId: string, options?: ApiCallOptions): Promise<DeleteItemHttpResponse>;
353
+ type DeleteItemHttpResponse = {
354
+ data: void;
355
+ headers: Headers;
356
+ status: 204;
357
+ };
358
+ type DeleteItemHttpError = {
359
+ data: ErrorResponseBody;
360
+ headers: Headers;
361
+ status: 401 | 403 | 404 | 500;
362
+ };
363
+ /**
364
+ * Finds and returns an item.
365
+ *
366
+ * @param itemId The item's unique identifier
367
+ * @throws GetItemHttpError
368
+ */
369
+ declare function getItem(itemId: string, options?: ApiCallOptions): Promise<GetItemHttpResponse>;
370
+ type GetItemHttpResponse = {
371
+ data: ItemResultResponseBody;
372
+ headers: Headers;
373
+ status: 200;
374
+ };
375
+ type GetItemHttpError = {
376
+ data: ErrorResponseBody;
377
+ headers: Headers;
378
+ status: 400 | 401 | 404 | 500;
379
+ };
380
+ /**
381
+ * Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
382
+ *
383
+ * @param itemId The item's unique identifier.
384
+ * @param body an object with the body content
385
+ * @throws UpdateItemHttpError
386
+ */
387
+ declare function updateItem(itemId: string, body: ItemsUpdateItemRequestBody, options?: ApiCallOptions): Promise<UpdateItemHttpResponse>;
388
+ type UpdateItemHttpResponse = {
389
+ data: ItemResultResponseBody;
390
+ headers: Headers;
391
+ status: 200;
392
+ };
393
+ type UpdateItemHttpError = {
394
+ data: ErrorResponseBody;
395
+ headers: Headers;
396
+ status: 400 | 401 | 403 | 404 | 409 | 500;
397
+ };
398
+ /**
399
+ * Finds and returns the collections (and tags) of an item. This endpoint does not return the user's favorites collection.
400
+ *
401
+ * @param itemId The item's unique identifier.
402
+ * @param query an object with query parameters
403
+ * @throws GetItemCollectionsHttpError
404
+ */
405
+ declare function getItemCollections(itemId: string, query: {
406
+ /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
407
+ limit?: number;
408
+ /** The case-sensitive string used to search for a collection by name. */
409
+ name?: string;
410
+ /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
411
+ next?: string;
412
+ /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
413
+ prev?: string;
414
+ /** The case-insensitive string used to search for a resource by name or description. */
415
+ query?: string;
416
+ /** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
417
+ sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
418
+ /** The case-sensitive string used to search for a collection by type. */
419
+ type?: CollectionTypes;
420
+ }, options?: ApiCallOptions): Promise<GetItemCollectionsHttpResponse>;
421
+ type GetItemCollectionsHttpResponse = {
422
+ data: ItemsListItemCollectionsResponseBody;
423
+ headers: Headers;
424
+ status: 200;
425
+ prev?: (options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
426
+ next?: (options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
427
+ };
428
+ type GetItemCollectionsHttpError = {
429
+ data: ErrorResponseBody;
430
+ headers: Headers;
431
+ status: 400 | 401 | 404 | 500;
432
+ };
433
+ /**
434
+ * Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
435
+ *
436
+ * @param itemId The item's unique identifier
437
+ * @param query an object with query parameters
438
+ * @throws GetPublishedItemsHttpError
439
+ */
440
+ declare function getPublishedItems(itemId: string, query: {
441
+ /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
442
+ limit?: number;
443
+ /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
444
+ next?: string;
445
+ /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
446
+ prev?: string;
447
+ /** The case-sensitive string used to search for an item by resourceType. */
448
+ resourceType?: ItemResourceTypeEnum;
449
+ /** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
450
+ sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
451
+ }, options?: ApiCallOptions): Promise<GetPublishedItemsHttpResponse>;
452
+ type GetPublishedItemsHttpResponse = {
453
+ data: ItemsListItemCollectionsResponseBody;
454
+ headers: Headers;
455
+ status: 200;
456
+ prev?: (options?: ApiCallOptions) => Promise<GetPublishedItemsHttpResponse>;
457
+ next?: (options?: ApiCallOptions) => Promise<GetPublishedItemsHttpResponse>;
458
+ };
459
+ type GetPublishedItemsHttpError = {
460
+ data: ErrorResponseBody;
461
+ headers: Headers;
462
+ status: 400 | 401 | 404 | 500;
463
+ };
464
+ /**
465
+ * Clears the cache for items api requests.
466
+ */
467
+ declare function clearCache(): void;
468
+ type ItemsAPI = {
469
+ /**
470
+ * Lists items that the user has access to.
471
+ *
472
+ * @param query an object with query parameters
473
+ * @throws GetItemsHttpError
474
+ */
475
+ getItems: typeof getItems;
476
+ /**
477
+ * Finds and returns the items service settings for the current tenant. Currently used to enable or disable usage metrics in the tenant.
478
+ *
479
+ * @throws GetItemsSettingsHttpError
480
+ */
481
+ getItemsSettings: typeof getItemsSettings;
482
+ /**
483
+ * Updates the settings provided in the patch body. Currently used to enable or disable usage metrics in the tenant.
484
+ *
485
+ * @param body an object with the body content
486
+ * @throws PatchItemsSettingsHttpError
487
+ */
488
+ patchItemsSettings: typeof patchItemsSettings;
489
+ /**
490
+ * Deletes an item and removes the item from all collections.
491
+ *
492
+ * @param itemId The item's unique identifier.
493
+ * @throws DeleteItemHttpError
494
+ */
495
+ deleteItem: typeof deleteItem;
496
+ /**
497
+ * Finds and returns an item.
498
+ *
499
+ * @param itemId The item's unique identifier
500
+ * @throws GetItemHttpError
501
+ */
502
+ getItem: typeof getItem;
503
+ /**
504
+ * Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
505
+ *
506
+ * @param itemId The item's unique identifier.
507
+ * @param body an object with the body content
508
+ * @throws UpdateItemHttpError
509
+ */
510
+ updateItem: typeof updateItem;
511
+ /**
512
+ * Finds and returns the collections (and tags) of an item. This endpoint does not return the user's favorites collection.
513
+ *
514
+ * @param itemId The item's unique identifier.
515
+ * @param query an object with query parameters
516
+ * @throws GetItemCollectionsHttpError
517
+ */
518
+ getItemCollections: typeof getItemCollections;
519
+ /**
520
+ * Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
521
+ *
522
+ * @param itemId The item's unique identifier
523
+ * @param query an object with query parameters
524
+ * @throws GetPublishedItemsHttpError
525
+ */
526
+ getPublishedItems: typeof getPublishedItems;
527
+ /**
528
+ * Clears the cache for items api requests.
529
+ */
530
+ clearCache: typeof clearCache;
531
+ };
532
+ /**
533
+ * Functions for the items api
534
+ */
535
+ declare const itemsExport: ItemsAPI;
536
+ //#endregion
4
537
  export { CollectionLinksResponseBody, CollectionMetaResponseBody, CollectionResultResponseBody, CollectionTypes, CollectionsLinksResponseBody, DeleteItemHttpError, DeleteItemHttpResponse, ErrorResponseBody, GetItemCollectionsHttpError, GetItemCollectionsHttpResponse, GetItemHttpError, GetItemHttpResponse, GetItemsHttpError, GetItemsHttpResponse, GetItemsSettingsHttpError, GetItemsSettingsHttpResponse, GetPublishedItemsHttpError, GetPublishedItemsHttpResponse, ItemLinksResponseBody, ItemMetaResponseBody, ItemResourceTypeEnum, ItemResultResponseBody, ItemTagResponseBody, ItemViewsResponseBody, ItemViewsWeeksResponseBody, ItemsAPI, ItemsLinksResponseBody, ItemsListItemCollectionsResponseBody, ItemsListItemsResponseBody, ItemsResourceSizeResponseBody, ItemsResultResponseBody, ItemsSettingsPatch, ItemsSettingsResponseBody, ItemsUpdateItemRequestBody, Link, Meta, PatchItemsSettingsHttpError, PatchItemsSettingsHttpResponse, ServiceError, SpaceTypeEnum, UpdateItemHttpError, UpdateItemHttpResponse, clearCache, itemsExport as default, deleteItem, getItem, getItemCollections, getItems, getItemsSettings, getPublishedItems, patchItemsSettings, updateItem };
package/items.js CHANGED
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
4
3
 
5
4
  //#region src/public/rest/items.ts
6
5
  /**