@qlik/api 2.3.0 → 2.4.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.
- package/analytics/change-stores.d.ts +40 -76
- package/analytics/change-stores.js +9 -10
- package/analytics.d.ts +1 -2
- package/analytics.js +5 -6
- package/api-keys.d.ts +46 -100
- package/api-keys.js +3 -4
- package/apps.d.ts +334 -461
- package/apps.js +74 -6
- package/assistants.d.ts +172 -337
- package/assistants.js +3 -4
- package/audits.d.ts +41 -85
- package/audits.js +3 -4
- package/auth-types.d.ts +110 -1
- package/auth-types.js +22 -1
- package/auth.d.ts +1 -2
- package/auth.js +1 -1
- package/automation-connections.d.ts +44 -95
- package/automation-connections.js +3 -4
- package/automation-connectors.d.ts +10 -20
- package/automation-connectors.js +3 -4
- package/automations.d.ts +54 -112
- package/automations.js +3 -4
- package/automl-deployments.d.ts +17 -36
- package/automl-deployments.js +3 -4
- package/automl-predictions.d.ts +12 -24
- package/automl-predictions.js +3 -4
- package/banners.d.ts +8 -14
- package/banners.js +3 -4
- package/brands.d.ts +19 -39
- package/brands.js +3 -4
- package/chunks/auth-B8lJw7rm.js +31 -0
- package/chunks/{interceptors-DipDBQQ5.js → boot-interceptors-DqRxTczb.js} +296 -248
- package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
- package/chunks/{invoke-fetch-B7lGscuQ.js → invoke-fetch-DMAi6Fg3.js} +3 -3
- package/chunks/{invoke-fetch-DhdyFZ0F.js → invoke-fetch-pMN6iqup.js} +2 -3
- package/chunks/platform-types-CECrZkOF.d.ts +29 -0
- package/chunks/{public-runtime-modules-QhLPeQr5.js → public-runtime-modules-2KfyI2qM.js} +5 -5
- package/chunks/{qix-RCUslia8.js → qix-BdNrIA4s.js} +19 -20
- package/chunks/{qix-chunk-entrypoint-WAS4NVTf.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
- package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
- package/collections.d.ts +67 -144
- package/collections.js +3 -4
- package/conditions.d.ts +87 -190
- package/conditions.js +3 -4
- package/consumption.d.ts +35 -72
- package/consumption.js +3 -4
- package/core/ip-policies.d.ts +43 -93
- package/core/ip-policies.js +5 -6
- package/core.d.ts +1 -2
- package/core.js +5 -6
- package/csp-origins.d.ts +42 -85
- package/csp-origins.js +3 -4
- package/csrf-token.d.ts +6 -11
- package/csrf-token.js +3 -4
- package/data-alerts.d.ts +152 -325
- package/data-alerts.js +3 -4
- package/data-assets.d.ts +16 -31
- package/data-assets.js +3 -4
- package/data-connections.d.ts +123 -257
- package/data-connections.js +3 -4
- package/data-credentials.d.ts +36 -76
- package/data-credentials.js +3 -4
- package/data-files.d.ts +60 -121
- package/data-files.js +3 -4
- package/data-governance/data-products.d.ts +429 -0
- package/data-governance/data-products.js +212 -0
- package/data-governance.d.ts +13 -0
- package/data-governance.js +12 -0
- package/data-qualities.d.ts +11 -25
- package/data-qualities.js +3 -4
- package/data-sets.d.ts +28 -57
- package/data-sets.js +3 -4
- package/data-sources.d.ts +45 -97
- package/data-sources.js +3 -4
- package/data-stores.d.ts +53 -107
- package/data-stores.js +3 -4
- package/dcaas.d.ts +32 -67
- package/dcaas.js +3 -4
- package/di-projects.d.ts +111 -136
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +29 -63
- package/direct-access-agents.js +3 -4
- package/encryption.d.ts +28 -59
- package/encryption.js +3 -4
- package/extensions.d.ts +35 -73
- package/extensions.js +3 -4
- package/global-types.d.ts +139 -1
- package/glossaries.d.ts +75 -158
- package/glossaries.js +3 -4
- package/groups.d.ts +58 -125
- package/groups.js +3 -4
- package/identity-providers.d.ts +148 -324
- package/identity-providers.js +3 -4
- package/index.d.ts +18 -4
- package/index.js +64 -19
- package/interceptors.d.ts +2 -3
- package/interceptors.js +104 -2
- package/invoke-fetch-types.d.ts +97 -1
- package/items.d.ts +85 -181
- package/items.js +3 -4
- package/knowledgebases.d.ts +137 -270
- package/knowledgebases.js +3 -4
- package/licenses.d.ts +71 -153
- package/licenses.js +3 -4
- package/lineage-graphs.d.ts +39 -85
- package/lineage-graphs.js +3 -4
- package/ml.d.ts +290 -621
- package/ml.js +3 -4
- package/notes.d.ts +9 -18
- package/notes.js +3 -4
- package/notifications.d.ts +14 -30
- package/notifications.js +3 -4
- package/oauth-clients.d.ts +98 -159
- package/oauth-clients.js +4 -5
- package/oauth-tokens.d.ts +16 -33
- package/oauth-tokens.js +3 -4
- package/package.json +6 -4
- package/qix.d.ts +46 -2
- package/qix.js +2 -3
- package/questions.d.ts +53 -110
- package/questions.js +3 -4
- package/quotas.d.ts +13 -26
- package/quotas.js +3 -4
- package/reload-tasks.d.ts +23 -46
- package/reload-tasks.js +3 -4
- package/reloads.d.ts +26 -52
- package/reloads.js +3 -4
- package/report-templates.d.ts +30 -63
- package/report-templates.js +3 -4
- package/reports.d.ts +111 -238
- package/reports.js +3 -4
- package/roles.d.ts +36 -77
- package/roles.js +3 -4
- package/sharing-tasks.d.ts +201 -427
- package/sharing-tasks.js +3 -4
- package/spaces.d.ts +71 -157
- package/spaces.js +3 -4
- package/tasks.d.ts +76 -164
- package/tasks.js +3 -4
- package/temp-contents.d.ts +17 -35
- package/temp-contents.js +3 -4
- package/tenant-settings.d.ts +298 -0
- package/tenant-settings.js +107 -0
- package/tenants.d.ts +31 -67
- package/tenants.js +3 -4
- package/themes.d.ts +27 -55
- package/themes.js +3 -4
- package/transports.d.ts +46 -106
- package/transports.js +3 -4
- package/ui-config.d.ts +8 -17
- package/ui-config.js +3 -4
- package/users.d.ts +80 -170
- package/users.js +3 -4
- package/web-integrations.d.ts +38 -83
- package/web-integrations.js +3 -4
- package/web-notifications.d.ts +14 -29
- package/web-notifications.js +3 -4
- package/webhooks.d.ts +77 -162
- package/webhooks.js +3 -4
- package/chunks/auth-BowS4SUR.js +0 -28
- package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
- package/chunks/auth-types-h43TVDpB.js +0 -24
- package/chunks/global-types-CEVAJebk.js +0 -1
- /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
- /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
- /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
- /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/items.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/items.d.ts
|
|
5
5
|
type CollectionTypes = "private" | "public" | "publicgoverned";
|
|
@@ -21,47 +21,33 @@ type ItemsListItemsResponseBody = {
|
|
|
21
21
|
links: ItemsLinksResponseBody;
|
|
22
22
|
};
|
|
23
23
|
type ItemsSettingsPatch = {
|
|
24
|
-
/** The operation to be performed. Only "replace" is supported. */
|
|
25
|
-
|
|
26
|
-
/** Field of Settings to be patched (updated). */
|
|
27
|
-
path: "/usageMetricsEnabled";
|
|
28
|
-
/** The value to be used within the operations. */
|
|
24
|
+
/** The operation to be performed. Only "replace" is supported. */op: "replace"; /** Field of Settings to be patched (updated). */
|
|
25
|
+
path: "/usageMetricsEnabled"; /** The value to be used within the operations. */
|
|
29
26
|
value: boolean;
|
|
30
27
|
}[];
|
|
31
28
|
type ItemsSettingsResponseBody = {
|
|
32
|
-
/** Decides if the usage metrics will be shown in the hub UI. */
|
|
33
|
-
usageMetricsEnabled: boolean;
|
|
29
|
+
/** Decides if the usage metrics will be shown in the hub UI. */usageMetricsEnabled: boolean;
|
|
34
30
|
};
|
|
35
31
|
type ItemsUpdateItemRequestBody = {
|
|
36
32
|
description?: string;
|
|
37
33
|
name?: string;
|
|
38
34
|
resourceAttributes?: unknown;
|
|
39
|
-
resourceCustomAttributes?: unknown;
|
|
40
|
-
/** The case-sensitive string used to search for an item by
|
|
41
|
-
|
|
42
|
-
/** The case-sensitive string
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
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. */
|
|
35
|
+
resourceCustomAttributes?: unknown; /** 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. */
|
|
36
|
+
resourceId?: string; /** 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. */
|
|
37
|
+
resourceLink?: string; /** Optional field defining the item's subtype, if any. */
|
|
38
|
+
resourceSubType?: string; /** The case-sensitive string defining the item's type. */
|
|
39
|
+
resourceType: ItemResourceTypeEnum; /** The RFC3339 datetime when the resource that the item references was last updated. */
|
|
40
|
+
resourceUpdatedAt?: string; /** The space's unique identifier. */
|
|
41
|
+
spaceId?: string; /** The item thumbnail's unique identifier. This is optional for internal resources. */
|
|
53
42
|
thumbnailId?: string;
|
|
54
43
|
};
|
|
55
44
|
type Link = {
|
|
56
45
|
href?: string;
|
|
57
46
|
};
|
|
58
47
|
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. */
|
|
48
|
+
/** Code is a unique identifier for this error class. */code?: string; /** Detail is a human-readable explanation specific to this occurrence of the problem. */
|
|
62
49
|
detail?: string;
|
|
63
|
-
meta?: Meta;
|
|
64
|
-
/** Title is the name of this class of errors. */
|
|
50
|
+
meta?: Meta; /** Title is the name of this class of errors. */
|
|
65
51
|
title?: string;
|
|
66
52
|
};
|
|
67
53
|
type CollectionLinksResponseBody = {
|
|
@@ -72,34 +58,24 @@ type CollectionLinksResponseBody = {
|
|
|
72
58
|
* Collection metadata and computed fields.
|
|
73
59
|
*/
|
|
74
60
|
type CollectionMetaResponseBody = {
|
|
75
|
-
/** Multiple items. */
|
|
76
|
-
items?: ItemsResultResponseBody;
|
|
61
|
+
/** Multiple items. */items?: ItemsResultResponseBody;
|
|
77
62
|
};
|
|
78
63
|
/**
|
|
79
64
|
* A collection.
|
|
80
65
|
*/
|
|
81
66
|
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. */
|
|
67
|
+
/** The RFC3339 datetime when the collection was created. */createdAt: string; /** The ID of the user who created the collection. This property is only populated if the JWT contains a userId. */
|
|
85
68
|
creatorId?: string;
|
|
86
|
-
description?: string;
|
|
87
|
-
|
|
88
|
-
|
|
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. */
|
|
69
|
+
description?: string; /** States if a collection has reached its items limit or not */
|
|
70
|
+
full?: boolean; /** The collection's unique identifier. */
|
|
71
|
+
id: string; /** The number of items that have been added to the collection that the user has access to. */
|
|
92
72
|
itemCount: number;
|
|
93
|
-
links: CollectionLinksResponseBody;
|
|
94
|
-
/** Collection metadata and computed fields. */
|
|
73
|
+
links: CollectionLinksResponseBody; /** Collection metadata and computed fields. */
|
|
95
74
|
meta?: CollectionMetaResponseBody;
|
|
96
|
-
name: string;
|
|
97
|
-
/** The ID of the tenant that owns the collection. This property is populated by using JWT. */
|
|
75
|
+
name: string; /** The ID of the tenant that owns the collection. This property is populated by using JWT. */
|
|
98
76
|
tenantId: string;
|
|
99
|
-
type: "private" | "public" | "favorite" | "publicgoverned";
|
|
100
|
-
/** The
|
|
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. */
|
|
77
|
+
type: "private" | "public" | "favorite" | "publicgoverned"; /** The RFC3339 datetime when the collection was last updated. */
|
|
78
|
+
updatedAt: string; /** The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId. */
|
|
103
79
|
updaterId?: string;
|
|
104
80
|
};
|
|
105
81
|
type CollectionsLinksResponseBody = {
|
|
@@ -119,13 +95,9 @@ type ItemLinksResponseBody = {
|
|
|
119
95
|
* Item metadata and computed fields.
|
|
120
96
|
*/
|
|
121
97
|
type ItemMetaResponseBody = {
|
|
122
|
-
/** The actions that the user can perform on the item. */
|
|
123
|
-
|
|
124
|
-
/** An array 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. */
|
|
98
|
+
/** The actions that the user can perform on the item. */actions: string[]; /** An array of collections that the item is part of. */
|
|
99
|
+
collections: ItemTagResponseBody[]; /** The flag that indicates if item is in the user's favorites collection. */
|
|
100
|
+
isFavorited: boolean; /** An array of tags that the item is part of. */
|
|
129
101
|
tags: ItemTagResponseBody[];
|
|
130
102
|
};
|
|
131
103
|
/**
|
|
@@ -136,82 +108,52 @@ type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "shar
|
|
|
136
108
|
* An item.
|
|
137
109
|
*/
|
|
138
110
|
type ItemResultResponseBody = {
|
|
139
|
-
/** The actions that the user can perform on the item. */
|
|
140
|
-
|
|
141
|
-
/** The ID of the
|
|
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. */
|
|
111
|
+
/** The actions that the user can perform on the item. */actions: string[]; /** The ID of the collections that the item has been added to. */
|
|
112
|
+
collectionIds: string[]; /** The RFC3339 datetime when the item was created. */
|
|
113
|
+
createdAt: string; /** The ID of the user who created the item. This is only populated if the JWT contains a userId. */
|
|
146
114
|
creatorId?: string;
|
|
147
|
-
description?: string;
|
|
148
|
-
/** The item's
|
|
149
|
-
id: string;
|
|
150
|
-
/** The flag that indicates if item is in the user's favorites collection. */
|
|
115
|
+
description?: string; /** The item's unique identifier. */
|
|
116
|
+
id: string; /** The flag that indicates if item is in the user's favorites collection. */
|
|
151
117
|
isFavorited: boolean;
|
|
152
118
|
itemViews?: ItemViewsResponseBody;
|
|
153
|
-
links: ItemLinksResponseBody;
|
|
154
|
-
/** Item metadata and computed fields. */
|
|
119
|
+
links: ItemLinksResponseBody; /** Item metadata and computed fields. */
|
|
155
120
|
meta: ItemMetaResponseBody;
|
|
156
|
-
name: string;
|
|
157
|
-
/** The ID of the user who owns the item. */
|
|
121
|
+
name: string; /** The ID of the user who owns the item. */
|
|
158
122
|
ownerId?: string;
|
|
159
|
-
resourceAttributes: unknown;
|
|
160
|
-
/** The RFC3339 datetime when the resource that the item references was created. */
|
|
123
|
+
resourceAttributes: unknown; /** The RFC3339 datetime when the resource that the item references was created. */
|
|
161
124
|
resourceCreatedAt: string;
|
|
162
|
-
resourceCustomAttributes: unknown;
|
|
163
|
-
/** The case-sensitive string used to search for an item by
|
|
164
|
-
|
|
165
|
-
|
|
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. */
|
|
125
|
+
resourceCustomAttributes: unknown; /** 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. */
|
|
126
|
+
resourceId?: string; /** 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. */
|
|
127
|
+
resourceLink?: string; /** The RFC3339 datetime when the resource last reload ended. */
|
|
128
|
+
resourceReloadEndTime?: string; /** If the resource last reload was successful or not. */
|
|
170
129
|
resourceReloadStatus?: string;
|
|
171
|
-
resourceSize?: ItemsResourceSizeResponseBody;
|
|
172
|
-
/**
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
/** The
|
|
177
|
-
|
|
178
|
-
/**
|
|
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. */
|
|
130
|
+
resourceSize?: ItemsResourceSizeResponseBody; /** Optional field defining the item's subtype, if any. */
|
|
131
|
+
resourceSubType?: string; /** The case-sensitive string defining the item's type. */
|
|
132
|
+
resourceType: ItemResourceTypeEnum; /** The RFC3339 datetime when the resource that the item references was last updated. */
|
|
133
|
+
resourceUpdatedAt: string; /** The space's unique identifier. */
|
|
134
|
+
spaceId?: string; /** The ID of the tenant that owns the item. This is populated using the JWT. */
|
|
135
|
+
tenantId: string; /** The item thumbnail's unique identifier. This is optional for internal resources. */
|
|
136
|
+
thumbnailId?: string; /** The RFC3339 datetime when the item was last updated. */
|
|
137
|
+
updatedAt: string; /** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
|
|
187
138
|
updaterId?: string;
|
|
188
139
|
};
|
|
189
140
|
/**
|
|
190
141
|
* Holds basic information about a tag or collection.
|
|
191
142
|
*/
|
|
192
143
|
type ItemTagResponseBody = {
|
|
193
|
-
/** The ID of the tag/collection. */
|
|
194
|
-
id: string;
|
|
195
|
-
/** The name of the tag/collection. */
|
|
144
|
+
/** The ID of the tag/collection. */id: string; /** The name of the tag/collection. */
|
|
196
145
|
name: string;
|
|
197
146
|
};
|
|
198
147
|
type ItemViewsResponseBody = {
|
|
199
|
-
/** Total number of views the resource got during the last 28 days. */
|
|
200
|
-
|
|
201
|
-
|
|
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). */
|
|
148
|
+
/** Total number of views the resource got during the last 28 days. */total?: number; /** 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. */
|
|
149
|
+
trend?: number; /** Number of unique users who viewed the resource during the last 28 days. */
|
|
150
|
+
unique?: number; /** Number of apps this dataset is used in (datasets only). */
|
|
206
151
|
usedBy?: number;
|
|
207
152
|
week?: ItemViewsWeeksResponseBody[];
|
|
208
153
|
};
|
|
209
154
|
type ItemViewsWeeksResponseBody = {
|
|
210
|
-
/** The RFC3339 datetime representing the start of the referenced week. */
|
|
211
|
-
|
|
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. */
|
|
155
|
+
/** The RFC3339 datetime representing the start of the referenced week. */start?: string; /** Total number of views the resource got during the referenced week. */
|
|
156
|
+
total?: number; /** Number of unique users who viewed the resource during the referenced week. */
|
|
215
157
|
unique?: number;
|
|
216
158
|
};
|
|
217
159
|
type ItemsLinksResponseBody = {
|
|
@@ -221,9 +163,7 @@ type ItemsLinksResponseBody = {
|
|
|
221
163
|
self?: Link;
|
|
222
164
|
};
|
|
223
165
|
type ItemsResourceSizeResponseBody = {
|
|
224
|
-
/** Size of the app on disk in bytes. */
|
|
225
|
-
appFile?: number;
|
|
226
|
-
/** Size of the app in memory in bytes. */
|
|
166
|
+
/** Size of the app on disk in bytes. */appFile?: number; /** Size of the app in memory in bytes. */
|
|
227
167
|
appMemory?: number;
|
|
228
168
|
};
|
|
229
169
|
/**
|
|
@@ -234,13 +174,9 @@ type ItemsResultResponseBody = {
|
|
|
234
174
|
links: ItemsLinksResponseBody;
|
|
235
175
|
};
|
|
236
176
|
type Meta = {
|
|
237
|
-
/** Further explanation of the error */
|
|
238
|
-
|
|
239
|
-
/** Is the error a
|
|
240
|
-
fault?: boolean;
|
|
241
|
-
/** Is the error temporary? */
|
|
242
|
-
temporary?: boolean;
|
|
243
|
-
/** Is the error a timeout? */
|
|
177
|
+
/** Further explanation of the error */explain?: unknown; /** Is the error a server-side fault? */
|
|
178
|
+
fault?: boolean; /** Is the error temporary? */
|
|
179
|
+
temporary?: boolean; /** Is the error a timeout? */
|
|
244
180
|
timeout?: boolean;
|
|
245
181
|
};
|
|
246
182
|
/**
|
|
@@ -254,48 +190,28 @@ type SpaceTypeEnum = "shared" | "managed" | "personal" | "data";
|
|
|
254
190
|
* @throws GetItemsHttpError
|
|
255
191
|
*/
|
|
256
192
|
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
|
-
|
|
259
|
-
/**
|
|
260
|
-
|
|
261
|
-
/** The
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
/** The
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
/**
|
|
272
|
-
|
|
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. */
|
|
193
|
+
/** The collection's unique identifier. Used to filter for items with a specific tag (collection type `public`), or collection. */collectionId?: string; /** User's unique identifier. */
|
|
194
|
+
createdByUserId?: string; /** The item's unique identifier. */
|
|
195
|
+
id?: string; /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
|
|
196
|
+
limit?: number; /** The case-insensitive string used to search for a resource by name. */
|
|
197
|
+
name?: string; /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
|
|
198
|
+
next?: string; /** 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). */
|
|
199
|
+
noActions?: boolean; /** User's unique identifier. */
|
|
200
|
+
notCreatedByUserId?: string; /** Owner identifier. */
|
|
201
|
+
notOwnerId?: string; /** Owner identifier. */
|
|
202
|
+
ownerId?: string; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
|
|
203
|
+
prev?: string; /** The case-insensitive string used to search for a resource by name or description. */
|
|
204
|
+
query?: string; /** 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. */
|
|
205
|
+
resourceId?: string; /** 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' */
|
|
206
|
+
resourceIds?: string; /** 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. */
|
|
207
|
+
resourceLink?: string; /** 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. */
|
|
208
|
+
resourceSubType?: string; /** 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
209
|
resourceType?: ItemResourceTypeEnum;
|
|
291
210
|
/** @deprecated
|
|
292
211
|
* Whether or not to return items in a shared space. */
|
|
293
|
-
shared?: boolean;
|
|
294
|
-
|
|
295
|
-
|
|
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'. */
|
|
212
|
+
shared?: boolean; /** 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. */
|
|
213
|
+
sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt" | "+recentlyUsed" | "-recentlyUsed"; /** The space's unique identifier (supports \'personal\' as spaceId). */
|
|
214
|
+
spaceId?: string; /** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */
|
|
299
215
|
spaceType?: SpaceTypeEnum;
|
|
300
216
|
}, options?: ApiCallOptions): Promise<GetItemsHttpResponse>;
|
|
301
217
|
type GetItemsHttpResponse = {
|
|
@@ -403,19 +319,12 @@ type UpdateItemHttpError = {
|
|
|
403
319
|
* @throws GetItemCollectionsHttpError
|
|
404
320
|
*/
|
|
405
321
|
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
|
-
|
|
408
|
-
/** The
|
|
409
|
-
|
|
410
|
-
/** The
|
|
411
|
-
|
|
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. */
|
|
322
|
+
/** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */limit?: number; /** The case-sensitive string used to search for a collection by name. */
|
|
323
|
+
name?: string; /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
|
|
324
|
+
next?: string; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
|
|
325
|
+
prev?: string; /** The case-insensitive string used to search for a resource by name or description. */
|
|
326
|
+
query?: string; /** 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. */
|
|
327
|
+
sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt"; /** The case-sensitive string used to search for a collection by type. */
|
|
419
328
|
type?: CollectionTypes;
|
|
420
329
|
}, options?: ApiCallOptions): Promise<GetItemCollectionsHttpResponse>;
|
|
421
330
|
type GetItemCollectionsHttpResponse = {
|
|
@@ -438,15 +347,10 @@ type GetItemCollectionsHttpError = {
|
|
|
438
347
|
* @throws GetPublishedItemsHttpError
|
|
439
348
|
*/
|
|
440
349
|
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
|
-
|
|
443
|
-
/** The
|
|
444
|
-
|
|
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. */
|
|
350
|
+
/** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */limit?: number; /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
|
|
351
|
+
next?: string; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
|
|
352
|
+
prev?: string; /** The case-sensitive string used to search for an item by resourceType. */
|
|
353
|
+
resourceType?: ItemResourceTypeEnum; /** 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
354
|
sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
|
|
451
355
|
}, options?: ApiCallOptions): Promise<GetPublishedItemsHttpResponse>;
|
|
452
356
|
type GetPublishedItemsHttpResponse = {
|
package/items.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/items.ts
|
|
5
5
|
/**
|
|
@@ -140,7 +140,6 @@ const itemsExport = {
|
|
|
140
140
|
getPublishedItems,
|
|
141
141
|
clearCache
|
|
142
142
|
};
|
|
143
|
-
var items_default = itemsExport;
|
|
144
143
|
|
|
145
144
|
//#endregion
|
|
146
|
-
export { clearCache,
|
|
145
|
+
export { clearCache, itemsExport as default, deleteItem, getItem, getItemCollections, getItems, getItemsSettings, getPublishedItems, patchItemsSettings, updateItem };
|