@qlik/api 0.0.16 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/README.md +1 -1
  2. package/api-keys.js +25 -25
  3. package/apps.d.ts +9 -1
  4. package/apps.js +97 -97
  5. package/audits.js +23 -23
  6. package/auth.js +14 -14
  7. package/automations.js +47 -47
  8. package/brands.js +35 -35
  9. package/chunks/4HB3TAEO.js +4 -4
  10. package/chunks/{HHOVS7QC.mjs → CHNBNLXY.js} +3 -3
  11. package/chunks/{3YV6X7S6.mjs → FFGE2RP7.js} +1 -1
  12. package/chunks/{HOCTJESP.mjs → JEGN7XQV.js} +3 -3
  13. package/chunks/{6WX5AGKQ.mjs → L2BJNKLV.js} +2 -2
  14. package/chunks/OPRGGO4C.js +8 -8
  15. package/chunks/{O4EAKEIN.mjs → RHF624NQ.js} +1 -1
  16. package/chunks/{BYD63JCG.mjs → SIU6HO6B.js} +5 -3
  17. package/chunks/{EHAANYDL.mjs → TT66UJZY.js} +3 -3
  18. package/chunks/{UKVTBYP6.mjs → XOVMZWDC.js} +2 -2
  19. package/chunks/{6AD3HYSF.mjs → XZQNE4HH.js} +1 -1
  20. package/collections.js +33 -33
  21. package/csp-origins.js +23 -23
  22. package/data-assets.js +21 -21
  23. package/data-connections.js +29 -29
  24. package/data-credentials.js +19 -19
  25. package/data-files.js +35 -35
  26. package/docs/authentication.md +5 -5
  27. package/docs/examples/fetch-spaces.md +1 -15
  28. package/docs/examples/show-sheet-list.md +1 -1
  29. package/docs/features.md +1 -1
  30. package/extensions.js +25 -25
  31. package/glossaries.js +59 -59
  32. package/groups.d.ts +0 -3
  33. package/groups.js +27 -27
  34. package/identity-providers.d.ts +144 -10
  35. package/identity-providers.js +27 -27
  36. package/index.js +53 -53
  37. package/items.js +27 -27
  38. package/licenses.js +29 -29
  39. package/package.json +36 -232
  40. package/qix.d.ts +1 -1
  41. package/qix.js +10 -10
  42. package/quotas.js +15 -15
  43. package/reload-tasks.js +21 -21
  44. package/reloads.js +19 -19
  45. package/roles.js +15 -15
  46. package/spaces.js +35 -35
  47. package/temp-contents.js +17 -17
  48. package/tenants.js +23 -23
  49. package/themes.js +25 -25
  50. package/transports.js +23 -23
  51. package/users.d.ts +1 -3
  52. package/users.js +31 -31
  53. package/web-integrations.js +21 -21
  54. package/web-notifications.js +23 -23
  55. package/webhooks.js +31 -31
  56. package/api-keys.d.mts +0 -336
  57. package/api-keys.mjs +0 -80
  58. package/apps.d.mts +0 -2431
  59. package/apps.mjs +0 -398
  60. package/audits.d.mts +0 -286
  61. package/audits.mjs +0 -64
  62. package/auth-types-nnUcWhuU.d.mts +0 -98
  63. package/auth.d.mts +0 -26
  64. package/auth.mjs +0 -14
  65. package/automations.d.mts +0 -682
  66. package/automations.mjs +0 -173
  67. package/brands.d.mts +0 -670
  68. package/brands.mjs +0 -123
  69. package/chunks/2YWCEGTS.js +0 -21
  70. package/chunks/34ZKUFEA.js +0 -41
  71. package/chunks/4WHZ4EIW.js +0 -57
  72. package/chunks/B4VPD3ZT.js +0 -574
  73. package/chunks/BM4OSDRZ.js +0 -17
  74. package/chunks/DCXUEDOW.mjs +0 -67
  75. package/chunks/MTAQE4WC.js +0 -10411
  76. package/chunks/PLOSYUG2.js +0 -25
  77. package/chunks/URIW2U5M.js +0 -17
  78. package/chunks/VSY5YIQY.mjs +0 -11
  79. package/chunks/WOYJLK4Y.js +0 -1623
  80. package/collections.d.mts +0 -581
  81. package/collections.mjs +0 -114
  82. package/csp-origins.d.mts +0 -273
  83. package/csp-origins.mjs +0 -69
  84. package/data-assets.d.mts +0 -205
  85. package/data-assets.mjs +0 -66
  86. package/data-connections.d.mts +0 -594
  87. package/data-connections.mjs +0 -103
  88. package/data-credentials.d.mts +0 -204
  89. package/data-credentials.mjs +0 -59
  90. package/data-files.d.mts +0 -562
  91. package/data-files.mjs +0 -123
  92. package/extensions.d.mts +0 -293
  93. package/extensions.mjs +0 -77
  94. package/global.types-5iFvFJvX.d.mts +0 -115
  95. package/glossaries.d.mts +0 -1173
  96. package/glossaries.mjs +0 -237
  97. package/groups.d.mts +0 -434
  98. package/groups.mjs +0 -88
  99. package/identity-providers.d.mts +0 -550
  100. package/identity-providers.mjs +0 -83
  101. package/index.d.mts +0 -142
  102. package/index.mjs +0 -716
  103. package/items.d.mts +0 -535
  104. package/items.mjs +0 -87
  105. package/licenses.d.mts +0 -459
  106. package/licenses.mjs +0 -92
  107. package/qix.d.mts +0 -11629
  108. package/qix.mjs +0 -10
  109. package/quotas.d.mts +0 -112
  110. package/quotas.mjs +0 -32
  111. package/reload-tasks.d.mts +0 -227
  112. package/reload-tasks.mjs +0 -62
  113. package/reloads.d.mts +0 -207
  114. package/reloads.mjs +0 -46
  115. package/roles.d.mts +0 -175
  116. package/roles.mjs +0 -31
  117. package/spaces.d.mts +0 -562
  118. package/spaces.mjs +0 -124
  119. package/temp-contents.d.mts +0 -167
  120. package/temp-contents.mjs +0 -41
  121. package/tenants.d.mts +0 -300
  122. package/tenants.mjs +0 -73
  123. package/themes.d.mts +0 -268
  124. package/themes.mjs +0 -77
  125. package/transports.d.mts +0 -319
  126. package/transports.mjs +0 -65
  127. package/users.d.mts +0 -631
  128. package/users.mjs +0 -104
  129. package/web-integrations.d.mts +0 -274
  130. package/web-integrations.mjs +0 -62
  131. package/web-notifications.d.mts +0 -250
  132. package/web-notifications.mjs +0 -69
  133. package/webhooks.d.mts +0 -445
  134. package/webhooks.mjs +0 -104
package/apps.mjs DELETED
@@ -1,398 +0,0 @@
1
- import {
2
- clearApiCache,
3
- invokeFetch
4
- } from "./chunks/3YV6X7S6.mjs";
5
- import "./chunks/EHAANYDL.mjs";
6
- import "./chunks/VSY5YIQY.mjs";
7
-
8
- // src/public/rest/apps.ts
9
- var createApp = async (body, options) => invokeFetch("apps", {
10
- method: "post",
11
- pathTemplate: "/api/v1/apps",
12
- body,
13
- contentType: "application/json",
14
- options
15
- });
16
- var getAppEvaluationComparison = async (baseid, comparisonid, query, options) => invokeFetch("apps", {
17
- method: "get",
18
- pathTemplate: "/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}",
19
- pathVariables: { baseid, comparisonid },
20
- query,
21
- options
22
- });
23
- var getAppEvaluationComparisonXml = async (baseid, comparisonid, options) => invokeFetch("apps", {
24
- method: "get",
25
- pathTemplate: "/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download",
26
- pathVariables: { baseid, comparisonid },
27
- options
28
- });
29
- var getAppEvaluation = async (id, query, options) => invokeFetch("apps", {
30
- method: "get",
31
- pathTemplate: "/api/v1/apps/evaluations/{id}",
32
- pathVariables: { id },
33
- query,
34
- options
35
- });
36
- var getAppEvaluationXml = async (id, options) => invokeFetch("apps", {
37
- method: "get",
38
- pathTemplate: "/api/v1/apps/evaluations/{id}/actions/download",
39
- pathVariables: { id },
40
- options
41
- });
42
- var importApp = async (query, body, options) => invokeFetch("apps", {
43
- method: "post",
44
- pathTemplate: "/api/v1/apps/import",
45
- query,
46
- body,
47
- contentType: "application/octet-stream",
48
- options
49
- });
50
- var getAppsPrivileges = async (options) => invokeFetch("apps", {
51
- method: "get",
52
- pathTemplate: "/api/v1/apps/privileges",
53
- options
54
- });
55
- var deleteApp = async (appId, options) => invokeFetch("apps", {
56
- method: "delete",
57
- pathTemplate: "/api/v1/apps/{appId}",
58
- pathVariables: { appId },
59
- options
60
- });
61
- var getAppInfo = async (appId, options) => invokeFetch("apps", {
62
- method: "get",
63
- pathTemplate: "/api/v1/apps/{appId}",
64
- pathVariables: { appId },
65
- options
66
- });
67
- var updateAppInfo = async (appId, body, options) => invokeFetch("apps", {
68
- method: "put",
69
- pathTemplate: "/api/v1/apps/{appId}",
70
- pathVariables: { appId },
71
- body,
72
- contentType: "application/json",
73
- options
74
- });
75
- var copyApp = async (appId, body, options) => invokeFetch("apps", {
76
- method: "post",
77
- pathTemplate: "/api/v1/apps/{appId}/copy",
78
- pathVariables: { appId },
79
- body,
80
- contentType: "application/json",
81
- options
82
- });
83
- var getAppDataLineage = async (appId, options) => invokeFetch("apps", {
84
- method: "get",
85
- pathTemplate: "/api/v1/apps/{appId}/data/lineage",
86
- pathVariables: { appId },
87
- options
88
- });
89
- var getAppDataMetadata = async (appId, options) => invokeFetch("apps", {
90
- method: "get",
91
- pathTemplate: "/api/v1/apps/{appId}/data/metadata",
92
- pathVariables: { appId },
93
- options
94
- });
95
- var exportApp = async (appId, query, options) => invokeFetch("apps", {
96
- method: "post",
97
- pathTemplate: "/api/v1/apps/{appId}/export",
98
- pathVariables: { appId },
99
- query,
100
- options
101
- });
102
- var getAppInsightAnalyses = async (appId, options) => invokeFetch("apps", {
103
- method: "get",
104
- pathTemplate: "/api/v1/apps/{appId}/insight-analyses",
105
- pathVariables: { appId },
106
- options
107
- });
108
- var getAppInsightAnalysisRecommendations = async (appId, body, options) => invokeFetch("apps", {
109
- method: "post",
110
- pathTemplate: "/api/v1/apps/{appId}/insight-analyses/actions/recommend",
111
- pathVariables: { appId },
112
- body,
113
- contentType: "application/json",
114
- options
115
- });
116
- var getAppInsightAnalysisModel = async (appId, options) => invokeFetch("apps", {
117
- method: "get",
118
- pathTemplate: "/api/v1/apps/{appId}/insight-analyses/model",
119
- pathVariables: { appId },
120
- options
121
- });
122
- var deleteAppMedia = async (appId, path, options) => invokeFetch("apps", {
123
- method: "delete",
124
- pathTemplate: "/api/v1/apps/{appId}/media/files/{path}",
125
- pathVariables: { appId, path },
126
- options
127
- });
128
- var getAppMedia = async (appId, path, options) => invokeFetch("apps", {
129
- method: "get",
130
- pathTemplate: "/api/v1/apps/{appId}/media/files/{path}",
131
- pathVariables: { appId, path },
132
- options
133
- });
134
- var uploadAppMedia = async (appId, path, body, options) => invokeFetch("apps", {
135
- method: "put",
136
- pathTemplate: "/api/v1/apps/{appId}/media/files/{path}",
137
- pathVariables: { appId, path },
138
- body,
139
- contentType: "application/octet-stream",
140
- options
141
- });
142
- var getAppMediaList = async (appId, path, query, options) => invokeFetch("apps", {
143
- method: "get",
144
- pathTemplate: "/api/v1/apps/{appId}/media/list/{path}",
145
- pathVariables: { appId, path },
146
- query,
147
- options
148
- });
149
- var getAppThumbnail = async (appId, options) => invokeFetch("apps", {
150
- method: "get",
151
- pathTemplate: "/api/v1/apps/{appId}/media/thumbnail",
152
- pathVariables: { appId },
153
- options
154
- });
155
- var updateAppObjectOwner = async (appId, objectId, body, options) => invokeFetch("apps", {
156
- method: "post",
157
- pathTemplate: "/api/v1/apps/{appId}/objects/{objectId}/actions/change-owner",
158
- pathVariables: { appId, objectId },
159
- body,
160
- contentType: "application/json",
161
- options
162
- });
163
- var updateAppOwner = async (appId, body, options) => invokeFetch("apps", {
164
- method: "put",
165
- pathTemplate: "/api/v1/apps/{appId}/owner",
166
- pathVariables: { appId },
167
- body,
168
- contentType: "application/json",
169
- options
170
- });
171
- var publishApp = async (appId, body, options) => invokeFetch("apps", {
172
- method: "post",
173
- pathTemplate: "/api/v1/apps/{appId}/publish",
174
- pathVariables: { appId },
175
- body,
176
- contentType: "application/json",
177
- options
178
- });
179
- var republishApp = async (appId, body, options) => invokeFetch("apps", {
180
- method: "put",
181
- pathTemplate: "/api/v1/apps/{appId}/publish",
182
- pathVariables: { appId },
183
- body,
184
- contentType: "application/json",
185
- options
186
- });
187
- var getAppReloadLogs = async (appId, options) => invokeFetch("apps", {
188
- method: "get",
189
- pathTemplate: "/api/v1/apps/{appId}/reloads/logs",
190
- pathVariables: { appId },
191
- options
192
- });
193
- var getAppReloadLog = async (appId, reloadId, options) => invokeFetch("apps", {
194
- method: "get",
195
- pathTemplate: "/api/v1/apps/{appId}/reloads/logs/{reloadId}",
196
- pathVariables: { appId, reloadId },
197
- options
198
- });
199
- var getAppReloadMetadata = async (appId, reloadId, query, options) => invokeFetch("apps", {
200
- method: "get",
201
- pathTemplate: "/api/v1/apps/{appId}/reloads/metadata/{reloadId}",
202
- pathVariables: { appId, reloadId },
203
- query,
204
- options
205
- });
206
- var getAppReportFilters = async (appId, query, options) => invokeFetch("apps", {
207
- method: "get",
208
- pathTemplate: "/api/v1/apps/{appId}/report-filters",
209
- pathVariables: { appId },
210
- query,
211
- options
212
- });
213
- var createAppReportFilter = async (appId, body, options) => invokeFetch("apps", {
214
- method: "post",
215
- pathTemplate: "/api/v1/apps/{appId}/report-filters",
216
- pathVariables: { appId },
217
- body,
218
- contentType: "application/json",
219
- options
220
- });
221
- var countAppReportFilters = async (appId, query, options) => invokeFetch("apps", {
222
- method: "get",
223
- pathTemplate: "/api/v1/apps/{appId}/report-filters/actions/count",
224
- pathVariables: { appId },
225
- query,
226
- options
227
- });
228
- var deleteAppReportFilter = async (appId, id, options) => invokeFetch("apps", {
229
- method: "delete",
230
- pathTemplate: "/api/v1/apps/{appId}/report-filters/{id}",
231
- pathVariables: { appId, id },
232
- options
233
- });
234
- var getAppReportFilter = async (appId, id, options) => invokeFetch("apps", {
235
- method: "get",
236
- pathTemplate: "/api/v1/apps/{appId}/report-filters/{id}",
237
- pathVariables: { appId, id },
238
- options
239
- });
240
- var getAppScriptHistory = async (appId, query, options) => invokeFetch("apps", {
241
- method: "get",
242
- pathTemplate: "/api/v1/apps/{appId}/scripts",
243
- pathVariables: { appId },
244
- query,
245
- options
246
- });
247
- var updateAppScript = async (appId, body, options) => invokeFetch("apps", {
248
- method: "post",
249
- pathTemplate: "/api/v1/apps/{appId}/scripts",
250
- pathVariables: { appId },
251
- body,
252
- contentType: "application/json",
253
- options
254
- });
255
- var deleteAppScript = async (appId, version, options) => invokeFetch("apps", {
256
- method: "delete",
257
- pathTemplate: "/api/v1/apps/{appId}/scripts/{version}",
258
- pathVariables: { appId, version },
259
- options
260
- });
261
- var getAppScript = async (appId, version, options) => invokeFetch("apps", {
262
- method: "get",
263
- pathTemplate: "/api/v1/apps/{appId}/scripts/{version}",
264
- pathVariables: { appId, version },
265
- options
266
- });
267
- var patchAppScript = async (appId, version, body, options) => invokeFetch("apps", {
268
- method: "patch",
269
- pathTemplate: "/api/v1/apps/{appId}/scripts/{version}",
270
- pathVariables: { appId, version },
271
- body,
272
- contentType: "application/json",
273
- options
274
- });
275
- var removeAppFromSpace = async (appId, options) => invokeFetch("apps", {
276
- method: "delete",
277
- pathTemplate: "/api/v1/apps/{appId}/space",
278
- pathVariables: { appId },
279
- options
280
- });
281
- var moveAppToSpace = async (appId, body, options) => invokeFetch("apps", {
282
- method: "put",
283
- pathTemplate: "/api/v1/apps/{appId}/space",
284
- pathVariables: { appId },
285
- body,
286
- contentType: "application/json",
287
- options
288
- });
289
- var getAppEvaluations = async (guid, query, options) => invokeFetch("apps", {
290
- method: "get",
291
- pathTemplate: "/api/v1/apps/{guid}/evaluations",
292
- pathVariables: { guid },
293
- query,
294
- options
295
- });
296
- var queueAppEvaluation = async (guid, options) => invokeFetch("apps", {
297
- method: "post",
298
- pathTemplate: "/api/v1/apps/{guid}/evaluations",
299
- pathVariables: { guid },
300
- options
301
- });
302
- function clearCache() {
303
- return clearApiCache("apps");
304
- }
305
- var appsExport = {
306
- createApp,
307
- getAppEvaluationComparison,
308
- getAppEvaluationComparisonXml,
309
- getAppEvaluation,
310
- getAppEvaluationXml,
311
- importApp,
312
- getAppsPrivileges,
313
- deleteApp,
314
- getAppInfo,
315
- updateAppInfo,
316
- copyApp,
317
- getAppDataLineage,
318
- getAppDataMetadata,
319
- exportApp,
320
- getAppInsightAnalyses,
321
- getAppInsightAnalysisRecommendations,
322
- getAppInsightAnalysisModel,
323
- deleteAppMedia,
324
- getAppMedia,
325
- uploadAppMedia,
326
- getAppMediaList,
327
- getAppThumbnail,
328
- updateAppObjectOwner,
329
- updateAppOwner,
330
- publishApp,
331
- republishApp,
332
- getAppReloadLogs,
333
- getAppReloadLog,
334
- getAppReloadMetadata,
335
- getAppReportFilters,
336
- createAppReportFilter,
337
- countAppReportFilters,
338
- deleteAppReportFilter,
339
- getAppReportFilter,
340
- getAppScriptHistory,
341
- updateAppScript,
342
- deleteAppScript,
343
- getAppScript,
344
- patchAppScript,
345
- removeAppFromSpace,
346
- moveAppToSpace,
347
- getAppEvaluations,
348
- queueAppEvaluation,
349
- clearCache
350
- };
351
- var apps_default = appsExport;
352
- export {
353
- clearCache,
354
- copyApp,
355
- countAppReportFilters,
356
- createApp,
357
- createAppReportFilter,
358
- apps_default as default,
359
- deleteApp,
360
- deleteAppMedia,
361
- deleteAppReportFilter,
362
- deleteAppScript,
363
- exportApp,
364
- getAppDataLineage,
365
- getAppDataMetadata,
366
- getAppEvaluation,
367
- getAppEvaluationComparison,
368
- getAppEvaluationComparisonXml,
369
- getAppEvaluationXml,
370
- getAppEvaluations,
371
- getAppInfo,
372
- getAppInsightAnalyses,
373
- getAppInsightAnalysisModel,
374
- getAppInsightAnalysisRecommendations,
375
- getAppMedia,
376
- getAppMediaList,
377
- getAppReloadLog,
378
- getAppReloadLogs,
379
- getAppReloadMetadata,
380
- getAppReportFilter,
381
- getAppReportFilters,
382
- getAppScript,
383
- getAppScriptHistory,
384
- getAppThumbnail,
385
- getAppsPrivileges,
386
- importApp,
387
- moveAppToSpace,
388
- patchAppScript,
389
- publishApp,
390
- queueAppEvaluation,
391
- removeAppFromSpace,
392
- republishApp,
393
- updateAppInfo,
394
- updateAppObjectOwner,
395
- updateAppOwner,
396
- updateAppScript,
397
- uploadAppMedia
398
- };
package/audits.d.mts DELETED
@@ -1,286 +0,0 @@
1
- import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
- import './auth-types-nnUcWhuU.mjs';
3
-
4
- type ErrorResponse = {
5
- /** @deprecated */
6
- error?: string;
7
- errors?: {
8
- code?: string;
9
- detail?: string;
10
- title?: string;
11
- }[];
12
- traceId?: string;
13
- };
14
- /**
15
- * The availability of the properties depends on the event and the context it was triggered in.
16
- */
17
- type EventExtensions = {
18
- /** Specifies the entity performing the action on behalf of another party listed as triggering the action. */
19
- actor?: {
20
- /** Opaque value identifying impersonating entity. */
21
- sub?: string;
22
- /** The type of the impersonating entity. */
23
- subType?: string;
24
- };
25
- /** Id of the owner of the resource affected by the eventContext. */
26
- ownerId?: string;
27
- /** Id of the space related to the action performed on the eventContext. */
28
- spaceId?: string;
29
- /** If the event originated from a sub resource the topLevelResourceId contains the id of the top level resource associated with the sub resource. */
30
- topLevelResourceId?: string;
31
- /** Might be present if the action is of type "updated" and should contain information about the changes made to the resource. */
32
- updates?: unknown;
33
- };
34
- type GetArchiveResult = {
35
- /** List of archived events. The structure of the events depend on their type and version. */
36
- data?: unknown[];
37
- };
38
- type GetByIDResult = {
39
- /** The type that content is encoded in, always "application/json". */
40
- contentType?: string;
41
- /** Additional information about the event's details. The structure depends on the type and version of the event. */
42
- data?: unknown;
43
- /** The event's unique identifier. */
44
- eventId?: string;
45
- /** The RFC3339 datetime when the event happened. */
46
- eventTime?: string;
47
- /** The type of event that describes committed action. */
48
- eventType?: string;
49
- /** The version of the event type. */
50
- eventTypeVersion?: string;
51
- /** The availability of the properties depends on the event and the context it was triggered in. */
52
- extensions?: EventExtensions;
53
- /** The resource item's unique identifier. */
54
- id?: string;
55
- links?: GetLinks;
56
- /** The source of the event message, usually the producing service. */
57
- source?: string;
58
- /** The ID of the tenant that owns the item. This is populated using the JWT. */
59
- tenantId?: string;
60
- /** The ID of the user who performed the action that triggered the event. */
61
- userId?: string;
62
- };
63
- type GetLinks = {
64
- /** @deprecated */
65
- Self?: Href;
66
- self?: Href;
67
- };
68
- type GetObjectsResult = {
69
- /** List of requested resources. */
70
- data?: string[];
71
- links?: ListLinks;
72
- };
73
- type GetResult = {
74
- /** List of audit items. */
75
- data?: GetByIDResult[];
76
- links?: ListLinks;
77
- };
78
- type GetSettingsResult = {
79
- /** Server configuration options. */
80
- data?: {
81
- /** Is Long Term Storage archiving enabled?. */
82
- ArchiveEnabled?: boolean;
83
- /** The events TTL in seconds. */
84
- EventTTL?: number;
85
- };
86
- };
87
- /**
88
- * @deprecated
89
- */
90
- type Href = {
91
- /** @deprecated */
92
- Href?: string;
93
- };
94
- type ListLinks = {
95
- /** @deprecated */
96
- Next?: Href;
97
- /** @deprecated */
98
- Prev?: Href;
99
- /** @deprecated */
100
- Self?: Href;
101
- next?: Href;
102
- prev?: Href;
103
- self?: Href;
104
- };
105
- /**
106
- * Finds and returns the persisted audit events for the given tenant.
107
- *
108
- * @param query an object with query parameters
109
- * @throws GetAuditsHttpError
110
- */
111
- declare const getAudits: (query: {
112
- /** The start/end time interval formatted in ISO 8601 to search by eventTime. For example, "?eventTime=2021-07-14T18:41:15.00Z/2021-07-14T18:41:15.99Z". */
113
- eventTime?: string;
114
- /** The case-sensitive string used to search by eventType. */
115
- eventType?: string;
116
- /** The comma separated list of audit unique identifiers. */
117
- id?: string;
118
- /** The maximum number of resources to return for a request. */
119
- limit?: number;
120
- /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
121
- next?: string;
122
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
123
- prev?: string;
124
- /** The property of a resource to sort on (default sort is -eventTime). The supported properties are source, eventType, and eventTime. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
125
- sort?: string;
126
- /** The case-sensitive string used to search by source. */
127
- source?: string;
128
- /** The case-sensitive string used to search by userId. */
129
- userId?: string;
130
- }, options?: ApiCallOptions) => Promise<GetAuditsHttpResponse>;
131
- type GetAuditsHttpResponse = {
132
- data: GetResult;
133
- headers: Headers;
134
- status: number;
135
- prev?: (options?: ApiCallOptions) => Promise<GetAuditsHttpResponse>;
136
- next?: (options?: ApiCallOptions) => Promise<GetAuditsHttpResponse>;
137
- };
138
- type GetAuditsHttpError = {
139
- data: ErrorResponse;
140
- headers: Headers;
141
- status: number;
142
- };
143
- /**
144
- * Finds and returns audit events from the archive, formatted as a JSON array, for the given date and tenant (in JWT).
145
- *
146
- * @param query an object with query parameters
147
- * @throws GetArchivedAuditsHttpError
148
- */
149
- declare const getArchivedAudits: (query: {
150
- /** Date to be used as filter and criteria during extraction. */
151
- date?: string;
152
- }, options?: ApiCallOptions) => Promise<GetArchivedAuditsHttpResponse>;
153
- type GetArchivedAuditsHttpResponse = {
154
- data: GetArchiveResult;
155
- headers: Headers;
156
- status: number;
157
- };
158
- type GetArchivedAuditsHttpError = {
159
- data: ErrorResponse;
160
- headers: Headers;
161
- status: number;
162
- };
163
- /**
164
- * It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.
165
- *
166
- * @throws GetAuditsSettingsHttpError
167
- */
168
- declare const getAuditsSettings: (options?: ApiCallOptions) => Promise<GetAuditsSettingsHttpResponse>;
169
- type GetAuditsSettingsHttpResponse = {
170
- data: GetSettingsResult;
171
- headers: Headers;
172
- status: number;
173
- };
174
- type GetAuditsSettingsHttpError = {
175
- data: ErrorResponse;
176
- headers: Headers;
177
- status: number;
178
- };
179
- /**
180
- * Finds and returns the distinct list of unique event sources.
181
- *
182
- * @throws GetAuditSourcesHttpError
183
- */
184
- declare const getAuditSources: (options?: ApiCallOptions) => Promise<GetAuditSourcesHttpResponse>;
185
- type GetAuditSourcesHttpResponse = {
186
- data: GetObjectsResult;
187
- headers: Headers;
188
- status: number;
189
- prev?: (options?: ApiCallOptions) => Promise<GetAuditSourcesHttpResponse>;
190
- next?: (options?: ApiCallOptions) => Promise<GetAuditSourcesHttpResponse>;
191
- };
192
- type GetAuditSourcesHttpError = {
193
- data: ErrorResponse;
194
- headers: Headers;
195
- status: number;
196
- };
197
- /**
198
- * Finds and returns the distinct list of unique event types.
199
- *
200
- * @throws GetAuditTypesHttpError
201
- */
202
- declare const getAuditTypes: (options?: ApiCallOptions) => Promise<GetAuditTypesHttpResponse>;
203
- type GetAuditTypesHttpResponse = {
204
- data: GetObjectsResult;
205
- headers: Headers;
206
- status: number;
207
- prev?: (options?: ApiCallOptions) => Promise<GetAuditTypesHttpResponse>;
208
- next?: (options?: ApiCallOptions) => Promise<GetAuditTypesHttpResponse>;
209
- };
210
- type GetAuditTypesHttpError = {
211
- data: ErrorResponse;
212
- headers: Headers;
213
- status: number;
214
- };
215
- /**
216
- * Finds and returns the persisted audit events for the given tenant.
217
- *
218
- * @param id The audit item's unique identifier.
219
- * @throws GetAuditHttpError
220
- */
221
- declare const getAudit: (id: string, options?: ApiCallOptions) => Promise<GetAuditHttpResponse>;
222
- type GetAuditHttpResponse = {
223
- data: GetByIDResult;
224
- headers: Headers;
225
- status: number;
226
- };
227
- type GetAuditHttpError = {
228
- data: ErrorResponse;
229
- headers: Headers;
230
- status: number;
231
- };
232
- /**
233
- * Clears the cache for audits api requests.
234
- */
235
- declare function clearCache(): void;
236
- interface AuditsAPI {
237
- /**
238
- * Finds and returns the persisted audit events for the given tenant.
239
- *
240
- * @param query an object with query parameters
241
- * @throws GetAuditsHttpError
242
- */
243
- getAudits: typeof getAudits;
244
- /**
245
- * Finds and returns audit events from the archive, formatted as a JSON array, for the given date and tenant (in JWT).
246
- *
247
- * @param query an object with query parameters
248
- * @throws GetArchivedAuditsHttpError
249
- */
250
- getArchivedAudits: typeof getArchivedAudits;
251
- /**
252
- * It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.
253
- *
254
- * @throws GetAuditsSettingsHttpError
255
- */
256
- getAuditsSettings: typeof getAuditsSettings;
257
- /**
258
- * Finds and returns the distinct list of unique event sources.
259
- *
260
- * @throws GetAuditSourcesHttpError
261
- */
262
- getAuditSources: typeof getAuditSources;
263
- /**
264
- * Finds and returns the distinct list of unique event types.
265
- *
266
- * @throws GetAuditTypesHttpError
267
- */
268
- getAuditTypes: typeof getAuditTypes;
269
- /**
270
- * Finds and returns the persisted audit events for the given tenant.
271
- *
272
- * @param id The audit item's unique identifier.
273
- * @throws GetAuditHttpError
274
- */
275
- getAudit: typeof getAudit;
276
- /**
277
- * Clears the cache for audits api requests.
278
- */
279
- clearCache: typeof clearCache;
280
- }
281
- /**
282
- * Functions for the audits api
283
- */
284
- declare const auditsExport: AuditsAPI;
285
-
286
- export { type AuditsAPI, type ErrorResponse, type EventExtensions, type GetArchiveResult, type GetArchivedAuditsHttpError, type GetArchivedAuditsHttpResponse, type GetAuditHttpError, type GetAuditHttpResponse, type GetAuditSourcesHttpError, type GetAuditSourcesHttpResponse, type GetAuditTypesHttpError, type GetAuditTypesHttpResponse, type GetAuditsHttpError, type GetAuditsHttpResponse, type GetAuditsSettingsHttpError, type GetAuditsSettingsHttpResponse, type GetByIDResult, type GetLinks, type GetObjectsResult, type GetResult, type GetSettingsResult, type Href, type ListLinks, clearCache, auditsExport as default, getArchivedAudits, getAudit, getAuditSources, getAuditTypes, getAudits, getAuditsSettings };