@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
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { HostConfig } from "../auth-types.js";
|
|
2
2
|
|
|
3
3
|
//#region src/qix/types/engine-schema.d.ts
|
|
4
|
-
declare const QIX_SCHEMA_VERSION = "12.
|
|
4
|
+
declare const QIX_SCHEMA_VERSION = "12.2697.0";
|
|
5
5
|
type AlfaNumString = {
|
|
6
6
|
/**
|
|
7
7
|
* Calculated value.
|
|
@@ -11921,11 +11921,9 @@ type SheetListDataCell = {
|
|
|
11921
11921
|
};
|
|
11922
11922
|
type SheetListItem = ListItem<SheetListData>;
|
|
11923
11923
|
type SheetListData = {
|
|
11924
|
-
/** from /qMetaDef/title */
|
|
11925
|
-
title: string;
|
|
11924
|
+
/** from /qMetaDef/title */title: string;
|
|
11926
11925
|
labelExpression: string;
|
|
11927
|
-
showCondition: any;
|
|
11928
|
-
/** from /qMetaDef/description */
|
|
11926
|
+
showCondition: any; /** from /qMetaDef/description */
|
|
11929
11927
|
description: string;
|
|
11930
11928
|
descriptionExpression: string;
|
|
11931
11929
|
thumbnail: any;
|
|
@@ -11940,73 +11938,48 @@ type VariableListData = {
|
|
|
11940
11938
|
};
|
|
11941
11939
|
type MeasureListItem = ListItem<MeasureListData>;
|
|
11942
11940
|
type MeasureListData = {
|
|
11943
|
-
/** from /qMetaDef/title */
|
|
11944
|
-
|
|
11945
|
-
/** from /qMetaDef/tags */
|
|
11946
|
-
tags: string[];
|
|
11947
|
-
/** from /qMeasure/qLabelExpression */
|
|
11941
|
+
/** from /qMetaDef/title */title: string; /** from /qMetaDef/tags */
|
|
11942
|
+
tags: string[]; /** from /qMeasure/qLabelExpression */
|
|
11948
11943
|
labelExpression: string;
|
|
11949
11944
|
};
|
|
11950
11945
|
type MasterObjectListItem = ListItem<MasterObjectListData>;
|
|
11951
11946
|
type MasterObjectListData = {
|
|
11952
|
-
/** from /qMetaDef/title */
|
|
11953
|
-
|
|
11954
|
-
/** from /
|
|
11955
|
-
labelExpression: string;
|
|
11956
|
-
/** from /visualization */
|
|
11957
|
-
visualization: any;
|
|
11958
|
-
/** from /qMetaDef/tags */
|
|
11947
|
+
/** from /qMetaDef/title */name: any; /** from /labelExpression */
|
|
11948
|
+
labelExpression: string; /** from /visualization */
|
|
11949
|
+
visualization: any; /** from /qMetaDef/tags */
|
|
11959
11950
|
tags: string[];
|
|
11960
11951
|
};
|
|
11961
11952
|
type DimensionListItem = ListItem<DimensionListData>;
|
|
11962
11953
|
type DimensionListData = {
|
|
11963
|
-
/** from /qMetaDef/title */
|
|
11964
|
-
|
|
11965
|
-
/** from /
|
|
11966
|
-
|
|
11967
|
-
/** from /qDim/qGrouping */
|
|
11968
|
-
grouping: string;
|
|
11969
|
-
/** from /qDimInfos */
|
|
11970
|
-
info: GenericDimensionInfo[];
|
|
11971
|
-
/** from /qDim/qLabelExpression */
|
|
11954
|
+
/** from /qMetaDef/title */title: string; /** from /qMetaDef/tags */
|
|
11955
|
+
tags: string[]; /** from /qDim/qGrouping */
|
|
11956
|
+
grouping: string; /** from /qDimInfos */
|
|
11957
|
+
info: GenericDimensionInfo[]; /** from /qDim/qLabelExpression */
|
|
11972
11958
|
labelExpression: string;
|
|
11973
11959
|
};
|
|
11974
11960
|
type BookmarkListItem = ListItem<BookmarkListData>;
|
|
11975
11961
|
type BookmarkListData = {
|
|
11976
|
-
/** /qMetaDef/title */
|
|
11977
|
-
|
|
11978
|
-
/** /
|
|
11979
|
-
|
|
11980
|
-
/** /sheetId */
|
|
11981
|
-
sheetId: string;
|
|
11982
|
-
/** /selectionFields */
|
|
11983
|
-
selectionFields: any;
|
|
11984
|
-
/** /creationDate */
|
|
11962
|
+
/** /qMetaDef/title */title: string; /** /qMetaDef/description */
|
|
11963
|
+
description: string; /** /sheetId */
|
|
11964
|
+
sheetId: string; /** /selectionFields */
|
|
11965
|
+
selectionFields: any; /** /creationDate */
|
|
11985
11966
|
creationDate: any;
|
|
11986
11967
|
};
|
|
11987
11968
|
type ODAGAppLinkListItem = ListItem<ODAGAppLinkListData>;
|
|
11988
11969
|
type ODAGAppLinkListData = {
|
|
11989
|
-
/** /qMetaDef/odagLinkRef */
|
|
11990
|
-
odagLinkRef: any;
|
|
11991
|
-
/** /qMetaDef/timestamp */
|
|
11970
|
+
/** /qMetaDef/odagLinkRef */odagLinkRef: any; /** /qMetaDef/timestamp */
|
|
11992
11971
|
timestamp: any;
|
|
11993
11972
|
};
|
|
11994
11973
|
type DynamicAppViewListItem = ListItem<DynamicAppViewListData>;
|
|
11995
11974
|
type DynamicAppViewListData = {
|
|
11996
|
-
/** /qMetaDef/odagLinkRef */
|
|
11997
|
-
odagLinkRef: any;
|
|
11998
|
-
/** /qMetaDef/timestamp */
|
|
11975
|
+
/** /qMetaDef/odagLinkRef */odagLinkRef: any; /** /qMetaDef/timestamp */
|
|
11999
11976
|
timestamp: any;
|
|
12000
11977
|
};
|
|
12001
11978
|
type StoryListItem = ListItem<StoryListData>;
|
|
12002
11979
|
type StoryListData = {
|
|
12003
|
-
/** /qMetaDef/title */
|
|
12004
|
-
|
|
12005
|
-
/** /
|
|
12006
|
-
description: string;
|
|
12007
|
-
/** /thumbnail */
|
|
12008
|
-
thumbnail: string;
|
|
12009
|
-
/** /rank */
|
|
11980
|
+
/** /qMetaDef/title */title: string; /** /qMetaDef/description */
|
|
11981
|
+
description: string; /** /thumbnail */
|
|
11982
|
+
thumbnail: string; /** /rank */
|
|
12010
11983
|
rank: any;
|
|
12011
11984
|
};
|
|
12012
11985
|
type ExpandedFieldListItem = {
|
|
@@ -12044,8 +12017,7 @@ type RpcObject = {
|
|
|
12044
12017
|
Validating: StateNotification;
|
|
12045
12018
|
Closed: StateNotification;
|
|
12046
12019
|
Closing: StateNotification;
|
|
12047
|
-
Cancelled: StateNotification;
|
|
12048
|
-
/** @deprecated */
|
|
12020
|
+
Cancelled: StateNotification; /** @deprecated */
|
|
12049
12021
|
state: number;
|
|
12050
12022
|
layoutSubscribe<L extends GenericObjectLayout = AnyGenericObjectLayout>(callback: LayoutSubscriptionCallback): LayoutSubscription<L>;
|
|
12051
12023
|
};
|
|
@@ -12148,11 +12120,8 @@ type Doc = RpcObject & NativeDocFunctions<Field, GenericBookmark, GenericDimensi
|
|
|
12148
12120
|
global: Global;
|
|
12149
12121
|
};
|
|
12150
12122
|
type StandardFunctions = {
|
|
12151
|
-
/** Alias for getAppProperties */
|
|
12152
|
-
|
|
12153
|
-
/** Alias for setAppProperties */
|
|
12154
|
-
setProperties(props: NxAppProperties): Promise<void>;
|
|
12155
|
-
/** Alias for getAppLayout */
|
|
12123
|
+
/** Alias for getAppProperties */getProperties(): Promise<NxAppProperties>; /** Alias for setAppProperties */
|
|
12124
|
+
setProperties(props: NxAppProperties): Promise<void>; /** Alias for getAppLayout */
|
|
12156
12125
|
getLayout(): Promise<NxAppLayout>;
|
|
12157
12126
|
};
|
|
12158
12127
|
type ModalFunctions = {
|
|
@@ -12285,21 +12254,13 @@ type CombinedWebSocketStateEvent = {
|
|
|
12285
12254
|
//#endregion
|
|
12286
12255
|
//#region src/qix/qix-types.d.ts
|
|
12287
12256
|
type OpenAppSessionProps = {
|
|
12288
|
-
/** App ID to open */
|
|
12289
|
-
|
|
12290
|
-
/** Set
|
|
12291
|
-
|
|
12292
|
-
|
|
12293
|
-
|
|
12294
|
-
|
|
12295
|
-
withoutData?: boolean;
|
|
12296
|
-
/** Use a separate reload engine to perform a reload */
|
|
12297
|
-
useReloadEngine?: boolean;
|
|
12298
|
-
/** Time-to-live in seconds. */
|
|
12299
|
-
ttlSeconds?: number;
|
|
12300
|
-
/** Workload Type */
|
|
12301
|
-
workloadType?: WorkloadType;
|
|
12302
|
-
/** Automatically resume a suspended websocket connection when user presence is detected */
|
|
12257
|
+
/** App ID to open */appId: string; /** Set a value to open an individual session to the same app that is different from the default */
|
|
12258
|
+
identity?: string; /** Hostconfig to connect to a URL and authenticate an app session */
|
|
12259
|
+
hostConfig?: HostConfig; /** Set to true if app should be opened without loading the data blob */
|
|
12260
|
+
withoutData?: boolean; /** Use a separate reload engine to perform a reload */
|
|
12261
|
+
useReloadEngine?: boolean; /** Time-to-live in seconds. */
|
|
12262
|
+
ttlSeconds?: number; /** Workload Type */
|
|
12263
|
+
workloadType?: WorkloadType; /** Automatically resume a suspended websocket connection when user presence is detected */
|
|
12303
12264
|
autoResume?: boolean;
|
|
12304
12265
|
};
|
|
12305
12266
|
type WorkloadType = "interact" | "report" | "reload" | "prepare" | "analyse" | "odag" | "dataflows" | "dynamicviews" | "appgeneration" | "evaluate" | "profile" | "di-qvd-gen" | "alert-preview" | "alert-evaluations" | "reporting-analytic" | "reporting-batch" | "automation" | "insight-advisor" | "automl-load" | "discovery";
|
|
@@ -12354,47 +12315,4 @@ type NativeReactHooks = {
|
|
|
12354
12315
|
*/
|
|
12355
12316
|
type UseAppHook = (appIdOrProps: string | OpenAppSessionProps) => Doc | undefined;
|
|
12356
12317
|
//#endregion
|
|
12357
|
-
|
|
12358
|
-
declare function openAppSession(appSessionProps: OpenAppSessionProps): {
|
|
12359
|
-
/**
|
|
12360
|
-
* Returns a promise of the Qix Doc object with a set of client-side Api extensions.
|
|
12361
|
-
* Note that while the AppSession object is returned immediately this promise might take a while
|
|
12362
|
-
* to resolve for bigger apps.
|
|
12363
|
-
*/
|
|
12364
|
-
getDoc(): Promise<Doc>;
|
|
12365
|
-
/**
|
|
12366
|
-
* @experimental
|
|
12367
|
-
* Add an event-listener for this app-session.
|
|
12368
|
-
*/
|
|
12369
|
-
onWebSocketEvent(listener: (event: WebSocketEvent) => void): () => void;
|
|
12370
|
-
/**
|
|
12371
|
-
* @experimental
|
|
12372
|
-
* Resume a suspended session. This will resume exactly
|
|
12373
|
-
* once if the session is currently suspended, otherwise
|
|
12374
|
-
* nothing will be done.
|
|
12375
|
-
*/
|
|
12376
|
-
resume(): Promise<void>;
|
|
12377
|
-
/**
|
|
12378
|
-
* When the app session is no longer in use it must be closed using this function.
|
|
12379
|
-
* If the same underlying enigma websocket is used somewhere else in the browser
|
|
12380
|
-
* this is basically a no op, but if this is the last/only usage
|
|
12381
|
-
* of the underlying enigma websocket that websocket will be closed.
|
|
12382
|
-
*/
|
|
12383
|
-
close(props?: CloseProps): Promise<void>;
|
|
12384
|
-
};
|
|
12385
|
-
interface QixAPI {
|
|
12386
|
-
/**
|
|
12387
|
-
* Open a qix session in engine on the current domain for the supplied appId. If the same app is opened multiple times
|
|
12388
|
-
* only a single enigma websocket session is opened and shared.
|
|
12389
|
-
* When all open sessions are closed again the shared enigma websocket session is also closed.
|
|
12390
|
-
* @param appId The resource id of the app to open
|
|
12391
|
-
* @param host Configuration of what host to connect to
|
|
12392
|
-
*/
|
|
12393
|
-
openAppSession: typeof openAppSession;
|
|
12394
|
-
}
|
|
12395
|
-
declare function withHostConfig(hostConfig: HostConfig | undefined): QixAPI;
|
|
12396
|
-
declare const qix: QixAPI & {
|
|
12397
|
-
withHostConfig: (hostConfig: HostConfig | undefined) => QixAPI;
|
|
12398
|
-
};
|
|
12399
|
-
//#endregion
|
|
12400
|
-
export { ListBoxProperties as $, NxVariableProperties as $a, NxLibraryMeasure as $i, GenericDimensionLayout as $n, SelectionObjectDef as $o, NxAutoSortByStateDef as $r, CyclicGroupPosition as $t, GenericObject as A, NxSelectionCellType as Aa, NxFieldDescription as Ai, FieldDefEx as An, SearchFieldMatchesItem as Ao, LogOnType as Ar, UsageEnum as As, Blob as At, GenericObjectPropertiesNodeLevel4 as B, NxTickCell as Ba, NxGroupMemberClass as Bi, FileDataFormat as Bn, SearchMatchCombination as Bo, NativeGenericMeasureFunctions as Br, BookmarkStateFieldPages as Bt, CurrentSelections as C, NxPatches as Ca, NxDimensionType as Ci, ExtendedLayoutBookmarkData as Cn, SearchAttribute as Co, LayoutBookmarkData as Cr, TotalMode as Cs, ApplyGroupStateWarningType as Ct, GenericDimension as D, NxRange as Da, NxExportFileType as Di, FailureData as Dn, SearchFieldDictionary as Do, ListObject as Dr, TreeDataDef as Ds, BNFDef as Dt, GenericBookmark as E, NxPivotValuePoint as Ea, NxEngineVersion as Ei, ExtensionListDef as En, SearchContextType as Eo, LineageInfo as Er, TreeData as Es, AssociationScore as Et, GenericObjectLayoutNodeLevel5 as F, NxStackPage as Fa, NxFieldTableResourceId as Fi, FieldListDef as Fn, SearchGroupItemMatch as Fo, MetaData as Fr, BookmarkFieldPageEx as Ft, RpcObject as G, NxTreeNode as Ga, NxHypercubeMode as Gi, FolderItemType as Gn, SearchSuggestItem as Go, NxAppLayout as Gr, ChildList as Gt, GenericObjectPropertiesNodeRec as H, NxTreeDimensionDef as Ha, NxGroupTail as Hi, FilterInfo as Hn, SearchObjectOptions as Ho, NativeGenericVariableFunctions as Hr, CalendarStrings as Ht, GenericObjectLayoutNodeRec as I, NxStackedPivotCell as Ia, NxFrequencyMode as Ii, FieldOrColumn as In, SearchGroupItemOptions as Io, NativeDocFunctions as Ir, BookmarkFieldVerifyResultState as It, DimensionListData as J, NxTrendline as Ja, NxInlineMeasureDef as Ji, GenericBookmarkEntry as Jn, SearchValueOptions as Jo, NxAttrDimInfo as Jr, CondDef as Jt, BookmarkListData as K, NxTreeRangeSelectInfo as Ka, NxInfo as Ki, FrequencyDistributionData as Kn, SearchSuggestionResult as Ko, NxAppProperties as Kr, ChildListDef as Kt, GenericObjectPropertiesNode as L, NxStateCounts as La, NxGetBookmarkOptions as Li, FieldScores as Ln, SearchGroupItemType as Lo, NativeFieldFunctions as Lr, BookmarkFieldVerifyWarning as Lt, GenericObjectLayoutNodeLevel2 as M, NxSimpleDimValue as Ma, NxFieldResourceId as Mi, FieldInTableData as Mn, SearchFieldValueItem as Mo, MeasureListDef as Mr, ValueExpression as Ms, BookmarkApplyAndVerifyResult as Mt, GenericObjectLayoutNodeLevel3 as N, NxSimpleValue as Na, NxFieldSelectionInfo as Ni, FieldInTableProfilingData as Nn, SearchGroup as No, MediaListDef as Nr, VariableList as Ns, BookmarkFieldItem as Nt, GenericListObject as O, NxRangeSelectInfo as Oa, NxExportState as Oi, FieldAttrType as On, SearchFieldMatch as Oo, ListObjectDef as Or, UndoInfo as Os, BNFDefMetaType as Ot, GenericObjectLayoutNodeLevel4 as P, NxSortIndicatorType as Pa, NxFieldSelectionMode as Pi, FieldList as Pn, SearchGroupItem as Po, MediaListItem as Pr, VariableListDef as Ps, BookmarkFieldPage as Pt, ExpandedFieldListItem as Q, NxVariableListItem as Qa, NxLibraryDimensionDef as Qi, GenericDimensionInfo as Qn, SelectionObject as Qo, NxAttributeExpressionValues as Qr, CustomConnector as Qt, GenericObjectPropertiesNodeLevel2 as R, NxStreamListEntry as Ra, NxGetObjectOptions as Ri, FieldType as Rn, SearchGroupOptions as Ro, NativeGenericBookmarkFunctions as Rr, BookmarkList as Rt, AnyGenericObjectProperties as S, NxPatchOperationType as Sa, NxDimensionInfo as Si, ExpansionData as Sn, SearchAssociationResult as So, KeyType as Sr, TextMacro as Ss, ApplyGroupStateWarning as St, FieldListObject as T, NxPivotPage as Ta, NxDownloadOptions as Ti, ExtensionList as Tn, SearchCombinationOptions as To, LayoutFieldInfo as Tr, TransformAppResult as Ts, ArrayOfNxValuePoint as Tt, GenericVariable as U, NxTreeDimensionInfo as Ua, NxGrpType as Ui, FilterType as Un, SearchPage as Uo, NativeGlobalFunctions as Ur, CharEncodingType as Ut, GenericObjectPropertiesNodeLevel5 as V, NxTreeDataOption as Va, NxGroupObjectId as Vi, FileType as Vn, SearchMatchCombinations as Vo, NativeGenericObjectFunctions as Vr, BookmarkVariableItem as Vt, UndoInfoObject as W, NxTreeMultiRangeSelectInfo as Wa, NxHighlightRanges as Wi, FolderItem as Wn, SearchResult as Wo, NativeVariableFunctions as Wr, CharRange as Wt, DynamicAppViewListData as X, NxTrendlineMode as Xa, NxLayoutErrors as Xi, GenericBookmarkProperties as Xn, SearchValueResult as Xo, NxAttrExprInfo as Xr, ContentLibraryList as Xt, DimensionListItem as Y, NxTrendlineDef as Ya, NxLTrendlineType as Yi, GenericBookmarkLayout as Yn, SearchValuePage as Yo, NxAttrExprDef as Yr, Connection as Yt, DynamicAppViewListItem as Z, NxValidationError as Za, NxLibraryDimension as Zi, GenericConnectMachine as Zn, SelectInfo as Zo, NxAttributeDimValues as Zr, ContentLibraryListItem as Zt, ObjectHelperFunctions as _, NxMultiRangeSelectInfo as _a, NxDerivedFieldDescriptionList as _i, EditorBreakpoint as _n, Rect as _o, HyperCubeDef as _r, TableViewConnectionPointSaveInfo as _s, AppEntry as _t, AppSession as a, NxLocalizedWarningCode as aa, NxCell as ai, DatabaseInfo as an, OtherMode as ao, GenericObjectLayoutAdditionalProperties as ar, StaticContentList as as, ODAGAppLinkListData as at, Global as b, NxPageTreeNode as ba, NxDimCellType as bi, ErrorData as bn, ScriptSyntaxError as bo, InteractDef as br, TableViewSaveInfo as bs, AppScript as bt, NativeReactHooks as c, NxMeasure as ca, NxContainerEntry as ci, DerivedFieldsInTableData as cn, Point as co, GenericVariableConstraints as cr, StaticContentUrlDef as cs, SheetListDataCell as ct, WorkloadType as d, NxMetaDef as da, NxContinuousRangeSelectInfo as di, DimensionReference as dn, ProgressMessage as do, GenericVariableType as dr, SymbolFrequency as ds, StoryListData as dt, NxLibraryMeasureDef as ea, NxAxisData as ei, DataField as en, NxViewPort as eo, GenericDimensionProperties as er, Size as es, ListItem as et, CombinedWebSocketStateEvent as f, NxMiniChart as fa, NxCurrentSelectionItem as fi, DoReloadExParams as fn, QFunction as fo, GraphMode as fr, SymbolValue as fs, StoryListItem as ft, ModalFunctions as g, NxMiniChartRows as ga, NxDerivedField as gi, DriveType as gn, RangeSelectInfo as go, HyperCube as gr, TableViewBroomPointSaveInfo as gs, AlternateStateData as gt, ListFunctions as h, NxMiniChartDef as ha, NxDataReductionMode as hi, DriveInfo as hn, QRange as ho, GroupStateInfo as hr, TableRow as hs, AlfaNumString as ht, withHostConfig as i, NxLocalizedErrorCode as ia, NxCardinalities as ii, Database as in, OtherLimitMode as io, GenericObjectLayout as ir, StateFieldValues as is, MeasureListItem as it, GenericObjectLayoutNode as j, NxSelectionInfo as ja, NxFieldProperties as ji, FieldDescription as jn, SearchFieldSelectionMode as jo, MeasureList as jr, ValueExpr as js, Bookmark as jt, GenericMeasure as k, NxSelectionCell as ka, NxFeature as ki, FieldAttributes as kn, SearchFieldMatchType as ko, LocaleInfo as kr, UndoInfoDef as ks, BNFType as kt, OpenAppSessionProps as l, NxMeasureInfo as la, NxContinuousDataOptions as li, DimensionList as ln, PositionMark as lo, GenericVariableLayout as lr, StringExpr as ls, SheetListDataCellBounds as lt, Doc as m, NxMiniChartData as ma, NxDataPage as mi, DocListEntry as mn, QMediaList as mo, GroupState as mr, TableRecord as ms, VariableListItem as mt, openAppSession as n, NxListObjectExpression as na, NxBookmark as ni, DataTable as nn, OdbcDsn as no, GenericMeasureProperties as nr, SourceKeyRecord as ns, MasterObjectListItem as nt, CloseProps as o, NxMatchingFieldInfo as oa, NxCellPosition as oi, DatabaseOwner as on, OtherSortMode as oo, GenericObjectProperties as or, StaticContentListItem as os, ODAGAppLinkListItem as ot, WebSocketEvent as p, NxMiniChartCell as pa, NxDataAreaPage as pi, DoReloadExResult as pn, QIX_SCHEMA_VERSION as po, GroupBookmarkData as pr, TableProfilingData as ps, VariableListData as pt, BookmarkListItem as q, NxTreeValue as qa, NxInlineDimensionDef as qi, FunctionGroup as qn, SearchTermResult as qo, NxAttrDimDef as qr, CodePage as qt, qix as r, NxListObjectExpressionDef as ra, NxCalcCond as ri, DataTableEx as rn, OleDbProvider as ro, GenericObjectEntry as rr, StateEnumType as rs, MeasureListData as rt, DocAction as s, NxMatchingFieldMode as sa, NxCellRows as si, DelimiterInfo as sn, OtherTotalSpecProp as so, GenericObjectPropertiesAdditionalProperties as sr, StaticContentUrl as ss, SheetListData as st, QixAPI as t, NxLinkedObjectInfo as ta, NxAxisTicks as ti, DataRecord as tn, ObjectInterface as to, GenericMeasureLayout as tr, SortCriteria as ts, MasterObjectListData as tt, UseAppHook as u, NxMeta as ua, NxContinuousMode as ui, DimensionListDef as un, ProgressData as uo, GenericVariableProperties as ur, StringExpression as us, SheetListItem as ut, SpecialObjectFunctions as v, NxPage as va, NxDerivedFieldsData as vi, EmbeddedSnapshot as vn, ReloadError as vo, InputFieldItem as vr, TableViewCtlSaveInfo as vs, AppObjectList as vt, Field as w, NxPivotDimensionCell as wa, NxDownloadInfo as wi, ExtendedPivotStateData as wn, SearchCharRange as wo, LayoutExclude as wr, TransformAppParameters as ws, ApplyGroupStatesResult as wt, AnyGenericObjectLayout as x, NxPatch as xa, NxDimension as xi, ErrorDataCode as xn, ScrollPosition as xo, InteractType as xr, TableViewTableWinSaveInfo as xs, AppScriptMeta as xt, StandardFunctions as y, NxPageTreeLevel as ya, NxDerivedGroup as yi, EmbeddedSnapshotDef as yn, SampleResult as yo, InterFieldSortData as yr, TableViewDlgSaveInfo as ys, AppObjectListDef as yt, GenericObjectPropertiesNodeLevel3 as z, NxTempBookmarkOptions as za, NxGroupDef as zi, FieldValue as zn, SearchGroupType as zo, NativeGenericDimensionFunctions as zr, BookmarkListDef as zt };
|
|
12318
|
+
export { MeasureListData as $, OleDbProvider as $a, NxListObjectExpressionDef as $i, GenericObjectEntry as $n, StateEnumType as $o, NxCalcCond as $r, DataTableEx as $t, GenericObjectLayoutNodeLevel4 as A, NxSortIndicatorType as Aa, NxFieldSelectionMode as Ai, FieldList as An, SearchGroupItem as Ao, MediaListItem as Ar, VariableListDef as As, BookmarkFieldPage as At, UndoInfoObject as B, NxTreeMultiRangeSelectInfo as Ba, NxHighlightRanges as Bi, FolderItem as Bn, SearchResult as Bo, NativeVariableFunctions as Br, CharRange as Bt, GenericDimension as C, NxRange as Ca, NxExportFileType as Ci, FailureData as Cn, SearchFieldDictionary as Co, ListObject as Cr, TreeDataDef as Cs, BNFDef as Ct, GenericObjectLayoutNode as D, NxSelectionInfo as Da, NxFieldProperties as Di, FieldDescription as Dn, SearchFieldSelectionMode as Do, MeasureList as Dr, ValueExpr as Ds, Bookmark as Dt, GenericObject as E, NxSelectionCellType as Ea, NxFieldDescription as Ei, FieldDefEx as En, SearchFieldMatchesItem as Eo, LogOnType as Er, UsageEnum as Es, Blob as Et, GenericObjectPropertiesNodeLevel3 as F, NxTempBookmarkOptions as Fa, NxGroupDef as Fi, FieldValue as Fn, SearchGroupType as Fo, NativeGenericDimensionFunctions as Fr, BookmarkListDef as Ft, DimensionListItem as G, NxTrendlineDef as Ga, NxLTrendlineType as Gi, GenericBookmarkLayout as Gn, SearchValuePage as Go, NxAttrExprDef as Gr, Connection as Gt, BookmarkListData as H, NxTreeRangeSelectInfo as Ha, NxInfo as Hi, FrequencyDistributionData as Hn, SearchSuggestionResult as Ho, NxAppProperties as Hr, ChildListDef as Ht, GenericObjectPropertiesNodeLevel4 as I, NxTickCell as Ia, NxGroupMemberClass as Ii, FileDataFormat as In, SearchMatchCombination as Io, NativeGenericMeasureFunctions as Ir, BookmarkStateFieldPages as It, ExpandedFieldListItem as J, NxVariableListItem as Ja, NxLibraryDimensionDef as Ji, GenericDimensionInfo as Jn, SelectionObject as Jo, NxAttributeExpressionValues as Jr, CustomConnector as Jt, DynamicAppViewListData as K, NxTrendlineMode as Ka, NxLayoutErrors as Ki, GenericBookmarkProperties as Kn, SearchValueResult as Ko, NxAttrExprInfo as Kr, ContentLibraryList as Kt, GenericObjectPropertiesNodeLevel5 as L, NxTreeDataOption as La, NxGroupObjectId as Li, FileType as Ln, SearchMatchCombinations as Lo, NativeGenericObjectFunctions as Lr, BookmarkVariableItem as Lt, GenericObjectLayoutNodeRec as M, NxStackedPivotCell as Ma, NxFrequencyMode as Mi, FieldOrColumn as Mn, SearchGroupItemOptions as Mo, NativeDocFunctions as Mr, BookmarkFieldVerifyResultState as Mt, GenericObjectPropertiesNode as N, NxStateCounts as Na, NxGetBookmarkOptions as Ni, FieldScores as Nn, SearchGroupItemType as No, NativeFieldFunctions as Nr, BookmarkFieldVerifyWarning as Nt, GenericObjectLayoutNodeLevel2 as O, NxSimpleDimValue as Oa, NxFieldResourceId as Oi, FieldInTableData as On, SearchFieldValueItem as Oo, MeasureListDef as Or, ValueExpression as Os, BookmarkApplyAndVerifyResult as Ot, GenericObjectPropertiesNodeLevel2 as P, NxStreamListEntry as Pa, NxGetObjectOptions as Pi, FieldType as Pn, SearchGroupOptions as Po, NativeGenericBookmarkFunctions as Pr, BookmarkList as Pt, MasterObjectListItem as Q, OdbcDsn as Qa, NxListObjectExpression as Qi, GenericMeasureProperties as Qn, SourceKeyRecord as Qo, NxBookmark as Qr, DataTable as Qt, GenericObjectPropertiesNodeRec as R, NxTreeDimensionDef as Ra, NxGroupTail as Ri, FilterInfo as Rn, SearchObjectOptions as Ro, NativeGenericVariableFunctions as Rr, CalendarStrings as Rt, GenericBookmark as S, NxPivotValuePoint as Sa, NxEngineVersion as Si, ExtensionListDef as Sn, SearchContextType as So, LineageInfo as Sr, TreeData as Ss, AssociationScore as St, GenericMeasure as T, NxSelectionCell as Ta, NxFeature as Ti, FieldAttributes as Tn, SearchFieldMatchType as To, LocaleInfo as Tr, UndoInfoDef as Ts, BNFType as Tt, BookmarkListItem as U, NxTreeValue as Ua, NxInlineDimensionDef as Ui, FunctionGroup as Un, SearchTermResult as Uo, NxAttrDimDef as Ur, CodePage as Ut, RpcObject as V, NxTreeNode as Va, NxHypercubeMode as Vi, FolderItemType as Vn, SearchSuggestItem as Vo, NxAppLayout as Vr, ChildList as Vt, DimensionListData as W, NxTrendline as Wa, NxInlineMeasureDef as Wi, GenericBookmarkEntry as Wn, SearchValueOptions as Wo, NxAttrDimInfo as Wr, CondDef as Wt, ListItem as X, NxViewPort as Xa, NxLibraryMeasureDef as Xi, GenericDimensionProperties as Xn, Size as Xo, NxAxisData as Xr, DataField as Xt, ListBoxProperties as Y, NxVariableProperties as Ya, NxLibraryMeasure as Yi, GenericDimensionLayout as Yn, SelectionObjectDef as Yo, NxAutoSortByStateDef as Yr, CyclicGroupPosition as Yt, MasterObjectListData as Z, ObjectInterface as Za, NxLinkedObjectInfo as Zi, GenericMeasureLayout as Zn, SortCriteria as Zo, NxAxisTicks as Zr, DataRecord as Zt, AnyGenericObjectLayout as _, NxPatch as _a, NxDimension as _i, ErrorDataCode as _n, ScrollPosition as _o, InteractType as _r, TableViewTableWinSaveInfo as _s, AppScriptMeta as _t, OpenAppSessionProps as a, NxMeasureInfo as aa, NxContinuousDataOptions as ai, DimensionList as an, PositionMark as ao, GenericVariableLayout as ar, StringExpr as as, SheetListDataCellBounds as at, Field as b, NxPivotDimensionCell as ba, NxDownloadInfo as bi, ExtendedPivotStateData as bn, SearchCharRange as bo, LayoutExclude as br, TransformAppParameters as bs, ApplyGroupStatesResult as bt, CombinedWebSocketStateEvent as c, NxMiniChart as ca, NxCurrentSelectionItem as ci, DoReloadExParams as cn, QFunction as co, GraphMode as cr, SymbolValue as cs, StoryListItem as ct, ListFunctions as d, NxMiniChartDef as da, NxDataReductionMode as di, DriveInfo as dn, QRange as do, GroupStateInfo as dr, TableRow as ds, AlfaNumString as dt, NxLocalizedErrorCode as ea, NxCardinalities as ei, Database as en, OtherLimitMode as eo, GenericObjectLayout as er, StateFieldValues as es, MeasureListItem as et, ModalFunctions as f, NxMiniChartRows as fa, NxDerivedField as fi, DriveType as fn, RangeSelectInfo as fo, HyperCube as fr, TableViewBroomPointSaveInfo as fs, AlternateStateData as ft, Global as g, NxPageTreeNode as ga, NxDimCellType as gi, ErrorData as gn, ScriptSyntaxError as go, InteractDef as gr, TableViewSaveInfo as gs, AppScript as gt, StandardFunctions as h, NxPageTreeLevel as ha, NxDerivedGroup as hi, EmbeddedSnapshotDef as hn, SampleResult as ho, InterFieldSortData as hr, TableViewDlgSaveInfo as hs, AppObjectListDef as ht, NativeReactHooks as i, NxMeasure as ia, NxContainerEntry as ii, DerivedFieldsInTableData as in, Point as io, GenericVariableConstraints as ir, StaticContentUrlDef as is, SheetListDataCell as it, GenericObjectLayoutNodeLevel5 as j, NxStackPage as ja, NxFieldTableResourceId as ji, FieldListDef as jn, SearchGroupItemMatch as jo, MetaData as jr, BookmarkFieldPageEx as jt, GenericObjectLayoutNodeLevel3 as k, NxSimpleValue as ka, NxFieldSelectionInfo as ki, FieldInTableProfilingData as kn, SearchGroup as ko, MediaListDef as kr, VariableList as ks, BookmarkFieldItem as kt, WebSocketEvent as l, NxMiniChartCell as la, NxDataAreaPage as li, DoReloadExResult as ln, QIX_SCHEMA_VERSION as lo, GroupBookmarkData as lr, TableProfilingData as ls, VariableListData as lt, SpecialObjectFunctions as m, NxPage as ma, NxDerivedFieldsData as mi, EmbeddedSnapshot as mn, ReloadError as mo, InputFieldItem as mr, TableViewCtlSaveInfo as ms, AppObjectList as mt, CloseProps as n, NxMatchingFieldInfo as na, NxCellPosition as ni, DatabaseOwner as nn, OtherSortMode as no, GenericObjectProperties as nr, StaticContentListItem as ns, ODAGAppLinkListItem as nt, UseAppHook as o, NxMeta as oa, NxContinuousMode as oi, DimensionListDef as on, ProgressData as oo, GenericVariableProperties as or, StringExpression as os, SheetListItem as ot, ObjectHelperFunctions as p, NxMultiRangeSelectInfo as pa, NxDerivedFieldDescriptionList as pi, EditorBreakpoint as pn, Rect as po, HyperCubeDef as pr, TableViewConnectionPointSaveInfo as ps, AppEntry as pt, DynamicAppViewListItem as q, NxValidationError as qa, NxLibraryDimension as qi, GenericConnectMachine as qn, SelectInfo as qo, NxAttributeDimValues as qr, ContentLibraryListItem as qt, DocAction as r, NxMatchingFieldMode as ra, NxCellRows as ri, DelimiterInfo as rn, OtherTotalSpecProp as ro, GenericObjectPropertiesAdditionalProperties as rr, StaticContentUrl as rs, SheetListData as rt, WorkloadType as s, NxMetaDef as sa, NxContinuousRangeSelectInfo as si, DimensionReference as sn, ProgressMessage as so, GenericVariableType as sr, SymbolFrequency as ss, StoryListData as st, AppSession as t, NxLocalizedWarningCode as ta, NxCell as ti, DatabaseInfo as tn, OtherMode as to, GenericObjectLayoutAdditionalProperties as tr, StaticContentList as ts, ODAGAppLinkListData as tt, Doc as u, NxMiniChartData as ua, NxDataPage as ui, DocListEntry as un, QMediaList as uo, GroupState as ur, TableRecord as us, VariableListItem as ut, AnyGenericObjectProperties as v, NxPatchOperationType as va, NxDimensionInfo as vi, ExpansionData as vn, SearchAssociationResult as vo, KeyType as vr, TextMacro as vs, ApplyGroupStateWarning as vt, GenericListObject as w, NxRangeSelectInfo as wa, NxExportState as wi, FieldAttrType as wn, SearchFieldMatch as wo, ListObjectDef as wr, UndoInfo as ws, BNFDefMetaType as wt, FieldListObject as x, NxPivotPage as xa, NxDownloadOptions as xi, ExtensionList as xn, SearchCombinationOptions as xo, LayoutFieldInfo as xr, TransformAppResult as xs, ArrayOfNxValuePoint as xt, CurrentSelections as y, NxPatches as ya, NxDimensionType as yi, ExtendedLayoutBookmarkData as yn, SearchAttribute as yo, LayoutBookmarkData as yr, TotalMode as ys, ApplyGroupStateWarningType as yt, GenericVariable as z, NxTreeDimensionInfo as za, NxGrpType as zi, FilterType as zn, SearchPage as zo, NativeGlobalFunctions as zr, CharEncodingType as zt };
|
package/collections.d.ts
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
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/collections.d.ts
|
|
5
5
|
type CollectionByIdPatch = {
|
|
6
|
-
/** The operation to be performed. */
|
|
7
|
-
op: "replace";
|
|
8
|
-
/** Field of collection to be patched. */
|
|
6
|
+
/** The operation to be performed. */op: "replace"; /** Field of collection to be patched. */
|
|
9
7
|
path: "/name" | "/description" | "/type";
|
|
10
8
|
/** The value to be used within the operations.
|
|
11
9
|
* - name: The name of the collection. Must not be "".
|
|
@@ -15,12 +13,10 @@ type CollectionByIdPatch = {
|
|
|
15
13
|
}[];
|
|
16
14
|
type CollectionTypes = "private" | "public" | "publicgoverned";
|
|
17
15
|
type CollectionsAddCollectionItemRequestBody = {
|
|
18
|
-
/** The item's unique identifier. */
|
|
19
|
-
id: string;
|
|
16
|
+
/** The item's unique identifier. */id: string;
|
|
20
17
|
};
|
|
21
18
|
type CollectionsCreateCollectionRequestBody = {
|
|
22
|
-
description?: string;
|
|
23
|
-
/** For `public` collections (tags), if name already exists in the tenant as a `public` collection, this call will fail with a `409` response. */
|
|
19
|
+
description?: string; /** For `public` collections (tags), if name already exists in the tenant as a `public` collection, this call will fail with a `409` response. */
|
|
24
20
|
name: string;
|
|
25
21
|
type: CollectionTypes;
|
|
26
22
|
};
|
|
@@ -48,12 +44,9 @@ type Link = {
|
|
|
48
44
|
href?: string;
|
|
49
45
|
};
|
|
50
46
|
type ServiceError = {
|
|
51
|
-
/** Code is a unique identifier for this error class. */
|
|
52
|
-
code?: string;
|
|
53
|
-
/** Detail is a human-readable explanation specific to this occurrence of the problem. */
|
|
47
|
+
/** Code is a unique identifier for this error class. */code?: string; /** Detail is a human-readable explanation specific to this occurrence of the problem. */
|
|
54
48
|
detail?: string;
|
|
55
|
-
meta?: Meta;
|
|
56
|
-
/** Title is the name of this class of errors. */
|
|
49
|
+
meta?: Meta; /** Title is the name of this class of errors. */
|
|
57
50
|
title?: string;
|
|
58
51
|
};
|
|
59
52
|
type CollectionLinksResponseBody = {
|
|
@@ -64,34 +57,24 @@ type CollectionLinksResponseBody = {
|
|
|
64
57
|
* Collection metadata and computed fields.
|
|
65
58
|
*/
|
|
66
59
|
type CollectionMetaResponseBody = {
|
|
67
|
-
/** Multiple items. */
|
|
68
|
-
items?: ItemsResultResponseBody;
|
|
60
|
+
/** Multiple items. */items?: ItemsResultResponseBody;
|
|
69
61
|
};
|
|
70
62
|
/**
|
|
71
63
|
* A collection.
|
|
72
64
|
*/
|
|
73
65
|
type CollectionResultResponseBody = {
|
|
74
|
-
/** The RFC3339 datetime when the collection was created. */
|
|
75
|
-
createdAt: string;
|
|
76
|
-
/** The ID of the user who created the collection. This property is only populated if the JWT contains a userId. */
|
|
66
|
+
/** 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. */
|
|
77
67
|
creatorId?: string;
|
|
78
|
-
description?: string;
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
/** The collection's unique identifier. */
|
|
82
|
-
id: string;
|
|
83
|
-
/** The number of items that have been added to the collection that the user has access to. */
|
|
68
|
+
description?: string; /** States if a collection has reached its items limit or not */
|
|
69
|
+
full?: boolean; /** The collection's unique identifier. */
|
|
70
|
+
id: string; /** The number of items that have been added to the collection that the user has access to. */
|
|
84
71
|
itemCount: number;
|
|
85
|
-
links: CollectionLinksResponseBody;
|
|
86
|
-
/** Collection metadata and computed fields. */
|
|
72
|
+
links: CollectionLinksResponseBody; /** Collection metadata and computed fields. */
|
|
87
73
|
meta?: CollectionMetaResponseBody;
|
|
88
|
-
name: string;
|
|
89
|
-
/** The ID of the tenant that owns the collection. This property is populated by using JWT. */
|
|
74
|
+
name: string; /** The ID of the tenant that owns the collection. This property is populated by using JWT. */
|
|
90
75
|
tenantId: string;
|
|
91
|
-
type: "private" | "public" | "favorite" | "publicgoverned";
|
|
92
|
-
/** The
|
|
93
|
-
updatedAt: string;
|
|
94
|
-
/** The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId. */
|
|
76
|
+
type: "private" | "public" | "favorite" | "publicgoverned"; /** The RFC3339 datetime when the collection was last updated. */
|
|
77
|
+
updatedAt: string; /** The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId. */
|
|
95
78
|
updaterId?: string;
|
|
96
79
|
};
|
|
97
80
|
type CollectionsLinksResponseBody = {
|
|
@@ -111,13 +94,9 @@ type ItemLinksResponseBody = {
|
|
|
111
94
|
* Item metadata and computed fields.
|
|
112
95
|
*/
|
|
113
96
|
type ItemMetaResponseBody = {
|
|
114
|
-
/** The actions that the user can perform on the item. */
|
|
115
|
-
|
|
116
|
-
/** An array of
|
|
117
|
-
collections: ItemTagResponseBody[];
|
|
118
|
-
/** The flag that indicates if item is in the user's favorites collection. */
|
|
119
|
-
isFavorited: boolean;
|
|
120
|
-
/** An array of tags that the item is part of. */
|
|
97
|
+
/** The actions that the user can perform on the item. */actions: string[]; /** An array of collections that the item is part of. */
|
|
98
|
+
collections: ItemTagResponseBody[]; /** The flag that indicates if item is in the user's favorites collection. */
|
|
99
|
+
isFavorited: boolean; /** An array of tags that the item is part of. */
|
|
121
100
|
tags: ItemTagResponseBody[];
|
|
122
101
|
};
|
|
123
102
|
/**
|
|
@@ -128,82 +107,52 @@ type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "shar
|
|
|
128
107
|
* An item.
|
|
129
108
|
*/
|
|
130
109
|
type ItemResultResponseBody = {
|
|
131
|
-
/** The actions that the user can perform on the item. */
|
|
132
|
-
|
|
133
|
-
/** The ID of the
|
|
134
|
-
collectionIds: string[];
|
|
135
|
-
/** The RFC3339 datetime when the item was created. */
|
|
136
|
-
createdAt: string;
|
|
137
|
-
/** The ID of the user who created the item. This is only populated if the JWT contains a userId. */
|
|
110
|
+
/** The actions that the user can perform on the item. */actions: string[]; /** The ID of the collections that the item has been added to. */
|
|
111
|
+
collectionIds: string[]; /** The RFC3339 datetime when the item was created. */
|
|
112
|
+
createdAt: string; /** The ID of the user who created the item. This is only populated if the JWT contains a userId. */
|
|
138
113
|
creatorId?: string;
|
|
139
|
-
description?: string;
|
|
140
|
-
/** The item's
|
|
141
|
-
id: string;
|
|
142
|
-
/** The flag that indicates if item is in the user's favorites collection. */
|
|
114
|
+
description?: string; /** The item's unique identifier. */
|
|
115
|
+
id: string; /** The flag that indicates if item is in the user's favorites collection. */
|
|
143
116
|
isFavorited: boolean;
|
|
144
117
|
itemViews?: ItemViewsResponseBody;
|
|
145
|
-
links: ItemLinksResponseBody;
|
|
146
|
-
/** Item metadata and computed fields. */
|
|
118
|
+
links: ItemLinksResponseBody; /** Item metadata and computed fields. */
|
|
147
119
|
meta: ItemMetaResponseBody;
|
|
148
|
-
name: string;
|
|
149
|
-
/** The ID of the user who owns the item. */
|
|
120
|
+
name: string; /** The ID of the user who owns the item. */
|
|
150
121
|
ownerId?: string;
|
|
151
|
-
resourceAttributes: unknown;
|
|
152
|
-
/** The RFC3339 datetime when the resource that the item references was created. */
|
|
122
|
+
resourceAttributes: unknown; /** The RFC3339 datetime when the resource that the item references was created. */
|
|
153
123
|
resourceCreatedAt: string;
|
|
154
|
-
resourceCustomAttributes: unknown;
|
|
155
|
-
/** The case-sensitive string used to search for an item by
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
resourceLink?: string;
|
|
159
|
-
/** The RFC3339 datetime when the resource last reload ended. */
|
|
160
|
-
resourceReloadEndTime?: string;
|
|
161
|
-
/** If the resource last reload was successful or not. */
|
|
124
|
+
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. */
|
|
125
|
+
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. */
|
|
126
|
+
resourceLink?: string; /** The RFC3339 datetime when the resource last reload ended. */
|
|
127
|
+
resourceReloadEndTime?: string; /** If the resource last reload was successful or not. */
|
|
162
128
|
resourceReloadStatus?: string;
|
|
163
|
-
resourceSize?: ItemsResourceSizeResponseBody;
|
|
164
|
-
/**
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
/** The
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
spaceId?: string;
|
|
172
|
-
/** The ID of the tenant that owns the item. This is populated using the JWT. */
|
|
173
|
-
tenantId: string;
|
|
174
|
-
/** The item thumbnail's unique identifier. This is optional for internal resources. */
|
|
175
|
-
thumbnailId?: string;
|
|
176
|
-
/** The RFC3339 datetime when the item was last updated. */
|
|
177
|
-
updatedAt: string;
|
|
178
|
-
/** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
|
|
129
|
+
resourceSize?: ItemsResourceSizeResponseBody; /** Optional field defining the item's subtype, if any. */
|
|
130
|
+
resourceSubType?: string; /** The case-sensitive string defining the item's type. */
|
|
131
|
+
resourceType: ItemResourceTypeEnum; /** The RFC3339 datetime when the resource that the item references was last updated. */
|
|
132
|
+
resourceUpdatedAt: string; /** The space's unique identifier. */
|
|
133
|
+
spaceId?: string; /** The ID of the tenant that owns the item. This is populated using the JWT. */
|
|
134
|
+
tenantId: string; /** The item thumbnail's unique identifier. This is optional for internal resources. */
|
|
135
|
+
thumbnailId?: string; /** The RFC3339 datetime when the item was last updated. */
|
|
136
|
+
updatedAt: string; /** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
|
|
179
137
|
updaterId?: string;
|
|
180
138
|
};
|
|
181
139
|
/**
|
|
182
140
|
* Holds basic information about a tag or collection.
|
|
183
141
|
*/
|
|
184
142
|
type ItemTagResponseBody = {
|
|
185
|
-
/** The ID of the tag/collection. */
|
|
186
|
-
id: string;
|
|
187
|
-
/** The name of the tag/collection. */
|
|
143
|
+
/** The ID of the tag/collection. */id: string; /** The name of the tag/collection. */
|
|
188
144
|
name: string;
|
|
189
145
|
};
|
|
190
146
|
type ItemViewsResponseBody = {
|
|
191
|
-
/** Total number of views the resource got during the last 28 days. */
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
trend?: number;
|
|
195
|
-
/** Number of unique users who viewed the resource during the last 28 days. */
|
|
196
|
-
unique?: number;
|
|
197
|
-
/** Number of apps this dataset is used in (datasets only). */
|
|
147
|
+
/** 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. */
|
|
148
|
+
trend?: number; /** Number of unique users who viewed the resource during the last 28 days. */
|
|
149
|
+
unique?: number; /** Number of apps this dataset is used in (datasets only). */
|
|
198
150
|
usedBy?: number;
|
|
199
151
|
week?: ItemViewsWeeksResponseBody[];
|
|
200
152
|
};
|
|
201
153
|
type ItemViewsWeeksResponseBody = {
|
|
202
|
-
/** The RFC3339 datetime representing the start of the referenced week. */
|
|
203
|
-
|
|
204
|
-
/** Total number of views the resource got during the referenced week. */
|
|
205
|
-
total?: number;
|
|
206
|
-
/** Number of unique users who viewed the resource during the referenced week. */
|
|
154
|
+
/** The RFC3339 datetime representing the start of the referenced week. */start?: string; /** Total number of views the resource got during the referenced week. */
|
|
155
|
+
total?: number; /** Number of unique users who viewed the resource during the referenced week. */
|
|
207
156
|
unique?: number;
|
|
208
157
|
};
|
|
209
158
|
type ItemsLinksResponseBody = {
|
|
@@ -213,9 +162,7 @@ type ItemsLinksResponseBody = {
|
|
|
213
162
|
self?: Link;
|
|
214
163
|
};
|
|
215
164
|
type ItemsResourceSizeResponseBody = {
|
|
216
|
-
/** Size of the app on disk in bytes. */
|
|
217
|
-
appFile?: number;
|
|
218
|
-
/** Size of the app in memory in bytes. */
|
|
165
|
+
/** Size of the app on disk in bytes. */appFile?: number; /** Size of the app in memory in bytes. */
|
|
219
166
|
appMemory?: number;
|
|
220
167
|
};
|
|
221
168
|
/**
|
|
@@ -226,13 +173,9 @@ type ItemsResultResponseBody = {
|
|
|
226
173
|
links: ItemsLinksResponseBody;
|
|
227
174
|
};
|
|
228
175
|
type Meta = {
|
|
229
|
-
/** Further explanation of the error */
|
|
230
|
-
|
|
231
|
-
/** Is the error a
|
|
232
|
-
fault?: boolean;
|
|
233
|
-
/** Is the error temporary? */
|
|
234
|
-
temporary?: boolean;
|
|
235
|
-
/** Is the error a timeout? */
|
|
176
|
+
/** Further explanation of the error */explain?: unknown; /** Is the error a server-side fault? */
|
|
177
|
+
fault?: boolean; /** Is the error temporary? */
|
|
178
|
+
temporary?: boolean; /** Is the error a timeout? */
|
|
236
179
|
timeout?: boolean;
|
|
237
180
|
};
|
|
238
181
|
/**
|
|
@@ -242,31 +185,22 @@ type Meta = {
|
|
|
242
185
|
* @throws GetCollectionsHttpError
|
|
243
186
|
*/
|
|
244
187
|
declare function getCollections(query: {
|
|
245
|
-
/** The case-sensitive string used to search for a resource by creatorId. */
|
|
246
|
-
|
|
247
|
-
/** The
|
|
248
|
-
|
|
249
|
-
/** Includes the list of items belonging to the collections. Supported parameters are 'limit', 'sort' and 'resourceType'. Supported formats are json formatted string or deep object style using square brackets. */
|
|
250
|
-
includeItems?: string;
|
|
251
|
-
/** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
|
|
252
|
-
limit?: number;
|
|
253
|
-
/** The case-sensitive string used to search for a collection by name. */
|
|
188
|
+
/** The case-sensitive string used to search for a resource by creatorId. */creatorId?: string; /** The collection's unique identifier. */
|
|
189
|
+
id?: string; /** Includes the list of items belonging to the collections. Supported parameters are 'limit', 'sort' and 'resourceType'. Supported formats are json formatted string or deep object style using square brackets. */
|
|
190
|
+
includeItems?: string; /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
|
|
191
|
+
limit?: number; /** The case-sensitive string used to search for a collection by name. */
|
|
254
192
|
name?: string;
|
|
255
193
|
/** The cursor to the next page of resources. Provide either the
|
|
256
194
|
* next or prev cursor, but not both. */
|
|
257
|
-
next?: string;
|
|
258
|
-
/** The
|
|
259
|
-
prev?: string;
|
|
260
|
-
/** The case-insensitive string used to search for a resource by name or description. */
|
|
195
|
+
next?: string; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
|
|
196
|
+
prev?: string; /** The case-insensitive string used to search for a resource by name or description. */
|
|
261
197
|
query?: string;
|
|
262
198
|
/** The property of a resource to sort on (default sort is +createdAt).
|
|
263
199
|
* The supported properties are createdAt, updatedAt, and name. A property
|
|
264
200
|
* must be prefixed by + or - to indicate ascending or descending sort order
|
|
265
201
|
* respectively. */
|
|
266
|
-
sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
|
|
267
|
-
/**
|
|
268
|
-
type?: CollectionTypes;
|
|
269
|
-
/** A comma-separated case-sensitive string used to filter by multiple types. */
|
|
202
|
+
sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt"; /** The case-sensitive string used to filter for a collection by type. Retrieve private collections with `private`, public collections with `publicgoverned`, and tags with `public`. */
|
|
203
|
+
type?: CollectionTypes; /** A comma-separated case-sensitive string used to filter by multiple types. */
|
|
270
204
|
types?: CollectionTypes[];
|
|
271
205
|
}, options?: ApiCallOptions): Promise<GetCollectionsHttpResponse>;
|
|
272
206
|
type GetCollectionsHttpResponse = {
|
|
@@ -393,30 +327,19 @@ type UpdateCollectionHttpError = {
|
|
|
393
327
|
* @throws GetCollectionItemsHttpError
|
|
394
328
|
*/
|
|
395
329
|
declare function getCollectionItems(collectionId: string, query: {
|
|
396
|
-
/** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
/** The
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
/** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
|
|
405
|
-
prev?: string;
|
|
406
|
-
/** The case-insensitive string used to search for a resource by name or description. */
|
|
407
|
-
query?: string;
|
|
408
|
-
/** 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. */
|
|
409
|
-
resourceId?: string;
|
|
410
|
-
/** 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. */
|
|
411
|
-
resourceLink?: string;
|
|
412
|
-
/** The case-sensitive string used to search for an item by resourceType. */
|
|
330
|
+
/** 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-insensitive string used to search for a resource by name. */
|
|
331
|
+
name?: string; /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
|
|
332
|
+
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). */
|
|
333
|
+
noActions?: boolean; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
|
|
334
|
+
prev?: string; /** The case-insensitive string used to search for a resource by name or description. */
|
|
335
|
+
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. */
|
|
336
|
+
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. */
|
|
337
|
+
resourceLink?: string; /** The case-sensitive string used to search for an item by resourceType. */
|
|
413
338
|
resourceType?: ItemResourceTypeEnum;
|
|
414
339
|
/** @deprecated
|
|
415
340
|
* Whether or not to return items in a shared space. */
|
|
416
|
-
shared?: boolean;
|
|
417
|
-
|
|
418
|
-
sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
|
|
419
|
-
/** The space's unique identifier (supports \'personal\' as spaceId). */
|
|
341
|
+
shared?: boolean; /** 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. */
|
|
342
|
+
sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt"; /** The space's unique identifier (supports \'personal\' as spaceId). */
|
|
420
343
|
spaceId?: string;
|
|
421
344
|
}, options?: ApiCallOptions): Promise<GetCollectionItemsHttpResponse>;
|
|
422
345
|
type GetCollectionItemsHttpResponse = {
|
package/collections.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/collections.ts
|
|
5
5
|
/**
|
|
@@ -198,7 +198,6 @@ const collectionsExport = {
|
|
|
198
198
|
getCollectionItem,
|
|
199
199
|
clearCache
|
|
200
200
|
};
|
|
201
|
-
var collections_default = collectionsExport;
|
|
202
201
|
|
|
203
202
|
//#endregion
|
|
204
|
-
export { addCollectionItem, clearCache, createCollection,
|
|
203
|
+
export { addCollectionItem, clearCache, createCollection, collectionsExport as default, deleteCollection, deleteCollectionItem, getCollection, getCollectionItem, getCollectionItems, getCollections, getFavoritesCollection, patchCollection, updateCollection };
|