@qlik/api 1.31.0 → 1.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/api-keys.js +2 -2
  2. package/apps.js +2 -2
  3. package/assistants.d.ts +1301 -0
  4. package/assistants.js +273 -0
  5. package/audits.js +2 -2
  6. package/auth.js +2 -2
  7. package/automation-connections.d.ts +366 -0
  8. package/automation-connections.js +91 -0
  9. package/automations.js +2 -2
  10. package/automl-deployments.d.ts +97 -0
  11. package/automl-deployments.js +27 -0
  12. package/automl-predictions.d.ts +214 -0
  13. package/automl-predictions.js +72 -0
  14. package/brands.js +2 -2
  15. package/chunks/{GUU3KZGK.js → RCLKKVYB.js} +1 -1
  16. package/chunks/{YKZ2QYHN.js → VVD2DPKQ.js} +2 -2
  17. package/chunks/{KBSD75QL.js → YTT2FEVE.js} +1 -1
  18. package/collections.js +2 -2
  19. package/conditions.d.ts +662 -0
  20. package/conditions.js +113 -0
  21. package/consumption.d.ts +182 -0
  22. package/consumption.js +24 -0
  23. package/csp-origins.js +2 -2
  24. package/csrf-token.d.ts +62 -0
  25. package/csrf-token.js +23 -0
  26. package/data-alerts.d.ts +1004 -0
  27. package/data-alerts.js +155 -0
  28. package/data-assets.js +2 -2
  29. package/data-connections.js +2 -2
  30. package/data-credentials.js +2 -2
  31. package/data-files.js +2 -2
  32. package/data-qualities.d.ts +175 -0
  33. package/data-qualities.js +44 -0
  34. package/data-sets.d.ts +424 -0
  35. package/data-sets.js +75 -0
  36. package/data-sources.d.ts +268 -0
  37. package/data-sources.js +39 -0
  38. package/data-stores.d.ts +537 -0
  39. package/data-stores.js +108 -0
  40. package/dcaas.d.ts +192 -0
  41. package/dcaas.js +39 -0
  42. package/di-projects.d.ts +673 -0
  43. package/di-projects.js +164 -0
  44. package/encryption.d.ts +370 -0
  45. package/encryption.js +98 -0
  46. package/extensions.js +2 -2
  47. package/glossaries.js +2 -2
  48. package/groups.js +2 -2
  49. package/identity-providers.js +2 -2
  50. package/index.d.ts +105 -1
  51. package/index.js +556 -4
  52. package/items.js +2 -2
  53. package/knowledgebases.d.ts +890 -0
  54. package/knowledgebases.js +169 -0
  55. package/licenses.d.ts +1 -1
  56. package/licenses.js +2 -2
  57. package/lineage-graphs.d.ts +712 -0
  58. package/lineage-graphs.js +92 -0
  59. package/ml.d.ts +2628 -0
  60. package/ml.js +384 -0
  61. package/notes.d.ts +110 -0
  62. package/notes.js +31 -0
  63. package/notifications.d.ts +98 -0
  64. package/notifications.js +24 -0
  65. package/oauth-clients.js +2 -2
  66. package/oauth-tokens.d.ts +126 -0
  67. package/oauth-tokens.js +31 -0
  68. package/package.json +28 -2
  69. package/qix.d.ts +1 -1
  70. package/qix.js +2 -2
  71. package/questions.d.ts +364 -0
  72. package/questions.js +34 -0
  73. package/quotas.js +2 -2
  74. package/reload-tasks.js +2 -2
  75. package/reloads.js +2 -2
  76. package/report-templates.d.ts +287 -0
  77. package/report-templates.js +80 -0
  78. package/reports.js +2 -2
  79. package/roles.js +2 -2
  80. package/sharing-tasks.d.ts +952 -0
  81. package/sharing-tasks.js +105 -0
  82. package/spaces.js +2 -2
  83. package/tasks.d.ts +564 -0
  84. package/tasks.js +106 -0
  85. package/temp-contents.js +2 -2
  86. package/tenants.js +2 -2
  87. package/themes.js +2 -2
  88. package/transports.js +2 -2
  89. package/ui-config.d.ts +274 -0
  90. package/ui-config.js +77 -0
  91. package/users.js +2 -2
  92. package/web-integrations.js +2 -2
  93. package/web-notifications.js +2 -2
  94. package/webhooks.js +2 -2
  95. /package/chunks/{DLKLPD7T.js → LTNGXTXG.js} +0 -0
package/ml.js ADDED
@@ -0,0 +1,384 @@
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/VVD2DPKQ.js";
5
+ import "./chunks/LTNGXTXG.js";
6
+ import "./chunks/2ZQ3ZX7F.js";
7
+
8
+ // src/public/rest/ml.ts
9
+ var getMlDeployments = async (query, options) => invokeFetch("ml", {
10
+ method: "get",
11
+ pathTemplate: "/api/v1/ml/deployments",
12
+ query,
13
+ options
14
+ });
15
+ var createMlDeployment = async (body, options) => invokeFetch("ml", {
16
+ method: "post",
17
+ pathTemplate: "/api/v1/ml/deployments",
18
+ body,
19
+ contentType: "application/json",
20
+ options
21
+ });
22
+ var deleteMlDeployment = async (deploymentId, options) => invokeFetch("ml", {
23
+ method: "delete",
24
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}",
25
+ pathVariables: { deploymentId },
26
+ options
27
+ });
28
+ var getMlDeployment = async (deploymentId, options) => invokeFetch("ml", {
29
+ method: "get",
30
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}",
31
+ pathVariables: { deploymentId },
32
+ options
33
+ });
34
+ var patchMlDeployment = async (deploymentId, body, options) => invokeFetch("ml", {
35
+ method: "patch",
36
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}",
37
+ pathVariables: { deploymentId },
38
+ body,
39
+ contentType: "application/json",
40
+ options
41
+ });
42
+ var activateModelsMlDeployment = async (deploymentId, options) => invokeFetch("ml", {
43
+ method: "post",
44
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/actions/activate-models",
45
+ pathVariables: { deploymentId },
46
+ options
47
+ });
48
+ var deactivateModelsMlDeployment = async (deploymentId, options) => invokeFetch("ml", {
49
+ method: "post",
50
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/actions/deactivate-models",
51
+ pathVariables: { deploymentId },
52
+ options
53
+ });
54
+ var getMlDeploymentAliases = async (deploymentId, query, options) => invokeFetch("ml", {
55
+ method: "get",
56
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases",
57
+ pathVariables: { deploymentId },
58
+ query,
59
+ options
60
+ });
61
+ var createMlDeploymentAliase = async (deploymentId, body, options) => invokeFetch("ml", {
62
+ method: "post",
63
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases",
64
+ pathVariables: { deploymentId },
65
+ body,
66
+ contentType: "application/json",
67
+ options
68
+ });
69
+ var deleteMlDeploymentAliase = async (deploymentId, aliasId, options) => invokeFetch("ml", {
70
+ method: "delete",
71
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}",
72
+ pathVariables: { deploymentId, aliasId },
73
+ options
74
+ });
75
+ var getMlDeploymentAliase = async (deploymentId, aliasId, options) => invokeFetch("ml", {
76
+ method: "get",
77
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}",
78
+ pathVariables: { deploymentId, aliasId },
79
+ options
80
+ });
81
+ var patchMlDeploymentAliase = async (deploymentId, aliasId, body, options) => invokeFetch("ml", {
82
+ method: "patch",
83
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}",
84
+ pathVariables: { deploymentId, aliasId },
85
+ body,
86
+ contentType: "application/json",
87
+ options
88
+ });
89
+ var runMlDeploymentAliaseRealtimePredictions = async (deploymentId, aliasName, query, body, options) => invokeFetch("ml", {
90
+ method: "post",
91
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run",
92
+ pathVariables: { deploymentId, aliasName },
93
+ query,
94
+ body,
95
+ contentType: "application/json",
96
+ options
97
+ });
98
+ var getMlDeploymentBatchPredictions = async (deploymentId, query, options) => invokeFetch("ml", {
99
+ method: "get",
100
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions",
101
+ pathVariables: { deploymentId },
102
+ query,
103
+ options
104
+ });
105
+ var createMlDeploymentBatchPrediction = async (deploymentId, body, options) => invokeFetch("ml", {
106
+ method: "post",
107
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions",
108
+ pathVariables: { deploymentId },
109
+ body,
110
+ contentType: "application/json",
111
+ options
112
+ });
113
+ var deleteMlDeploymentBatchPrediction = async (deploymentId, batchPredictionId, options) => invokeFetch("ml", {
114
+ method: "delete",
115
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}",
116
+ pathVariables: { deploymentId, batchPredictionId },
117
+ options
118
+ });
119
+ var getMlDeploymentBatchPrediction = async (deploymentId, batchPredictionId, options) => invokeFetch("ml", {
120
+ method: "get",
121
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}",
122
+ pathVariables: { deploymentId, batchPredictionId },
123
+ options
124
+ });
125
+ var patchMlDeploymentBatchPrediction = async (deploymentId, batchPredictionId, body, options) => invokeFetch("ml", {
126
+ method: "patch",
127
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}",
128
+ pathVariables: { deploymentId, batchPredictionId },
129
+ body,
130
+ contentType: "application/json",
131
+ options
132
+ });
133
+ var predictMlDeploymentBatchPrediction = async (deploymentId, batchPredictionId, options) => invokeFetch("ml", {
134
+ method: "post",
135
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict",
136
+ pathVariables: { deploymentId, batchPredictionId },
137
+ options
138
+ });
139
+ var deleteMlDeploymentBatchPredictionSchedule = async (deploymentId, batchPredictionId, options) => invokeFetch("ml", {
140
+ method: "delete",
141
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
142
+ pathVariables: { deploymentId, batchPredictionId },
143
+ options
144
+ });
145
+ var getMlDeploymentBatchPredictionSchedule = async (deploymentId, batchPredictionId, options) => invokeFetch("ml", {
146
+ method: "get",
147
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
148
+ pathVariables: { deploymentId, batchPredictionId },
149
+ options
150
+ });
151
+ var updateMlDeploymentBatchPredictionSchedule = async (deploymentId, batchPredictionId, body, options) => invokeFetch("ml", {
152
+ method: "patch",
153
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
154
+ pathVariables: { deploymentId, batchPredictionId },
155
+ body,
156
+ contentType: "application/json",
157
+ options
158
+ });
159
+ var setMlDeploymentBatchPredictionSchedule = async (deploymentId, batchPredictionId, body, options) => invokeFetch("ml", {
160
+ method: "put",
161
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
162
+ pathVariables: { deploymentId, batchPredictionId },
163
+ body,
164
+ contentType: "application/json",
165
+ options
166
+ });
167
+ var addMlDeploymentModels = async (deploymentId, body, options) => invokeFetch("ml", {
168
+ method: "post",
169
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/models/actions/add",
170
+ pathVariables: { deploymentId },
171
+ body,
172
+ contentType: "application/json",
173
+ options
174
+ });
175
+ var removeMlDeploymentModels = async (deploymentId, body, options) => invokeFetch("ml", {
176
+ method: "post",
177
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/models/actions/remove",
178
+ pathVariables: { deploymentId },
179
+ body,
180
+ contentType: "application/json",
181
+ options
182
+ });
183
+ var runMlDeploymentRealtimePredictions = async (deploymentId, query, body, options) => invokeFetch("ml", {
184
+ method: "post",
185
+ pathTemplate: "/api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run",
186
+ pathVariables: { deploymentId },
187
+ query,
188
+ body,
189
+ contentType: "application/json",
190
+ options
191
+ });
192
+ var getMlExperiments = async (query, options) => invokeFetch("ml", {
193
+ method: "get",
194
+ pathTemplate: "/api/v1/ml/experiments",
195
+ query,
196
+ options
197
+ });
198
+ var createMlExperiment = async (body, options) => invokeFetch("ml", {
199
+ method: "post",
200
+ pathTemplate: "/api/v1/ml/experiments",
201
+ body,
202
+ contentType: "application/json",
203
+ options
204
+ });
205
+ var deleteMlExperiment = async (experimentId, options) => invokeFetch("ml", {
206
+ method: "delete",
207
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}",
208
+ pathVariables: { experimentId },
209
+ options
210
+ });
211
+ var getMlExperiment = async (experimentId, options) => invokeFetch("ml", {
212
+ method: "get",
213
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}",
214
+ pathVariables: { experimentId },
215
+ options
216
+ });
217
+ var patchMlExperiment = async (experimentId, body, options) => invokeFetch("ml", {
218
+ method: "patch",
219
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}",
220
+ pathVariables: { experimentId },
221
+ body,
222
+ contentType: "application/json",
223
+ options
224
+ });
225
+ var getMlExperimentModels = async (experimentId, query, options) => invokeFetch("ml", {
226
+ method: "get",
227
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}/models",
228
+ pathVariables: { experimentId },
229
+ query,
230
+ options
231
+ });
232
+ var getMlExperimentModel = async (experimentId, modelId, options) => invokeFetch("ml", {
233
+ method: "get",
234
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}/models/{modelId}",
235
+ pathVariables: { experimentId, modelId },
236
+ options
237
+ });
238
+ var getMlExperimentVersions = async (experimentId, query, options) => invokeFetch("ml", {
239
+ method: "get",
240
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions",
241
+ pathVariables: { experimentId },
242
+ query,
243
+ options
244
+ });
245
+ var createMlExperimentVersion = async (experimentId, body, options) => invokeFetch("ml", {
246
+ method: "post",
247
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions",
248
+ pathVariables: { experimentId },
249
+ body,
250
+ contentType: "application/json",
251
+ options
252
+ });
253
+ var deleteMlExperimentVersion = async (experimentId, experimentVersionId, options) => invokeFetch("ml", {
254
+ method: "delete",
255
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}",
256
+ pathVariables: { experimentId, experimentVersionId },
257
+ options
258
+ });
259
+ var getMlExperimentVersion = async (experimentId, experimentVersionId, options) => invokeFetch("ml", {
260
+ method: "get",
261
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}",
262
+ pathVariables: { experimentId, experimentVersionId },
263
+ options
264
+ });
265
+ var patchMlExperimentVersion = async (experimentId, experimentVersionId, body, options) => invokeFetch("ml", {
266
+ method: "patch",
267
+ pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}",
268
+ pathVariables: { experimentId, experimentVersionId },
269
+ body,
270
+ contentType: "application/json",
271
+ options
272
+ });
273
+ var cancelMlJob = async (corrType, corrId, options) => invokeFetch("ml", {
274
+ method: "post",
275
+ pathTemplate: "/api/v1/ml/jobs/{corrType}/{corrId}/actions/cancel",
276
+ pathVariables: { corrType, corrId },
277
+ options
278
+ });
279
+ var createMlProfileInsight = async (body, options) => invokeFetch("ml", {
280
+ method: "post",
281
+ pathTemplate: "/api/v1/ml/profile-insights",
282
+ body,
283
+ contentType: "application/json",
284
+ options
285
+ });
286
+ var getMlProfileInsight = async (dataSetId, options) => invokeFetch("ml", {
287
+ method: "get",
288
+ pathTemplate: "/api/v1/ml/profile-insights/{dataSetId}",
289
+ pathVariables: { dataSetId },
290
+ options
291
+ });
292
+ function clearCache() {
293
+ return clearApiCache("ml");
294
+ }
295
+ var mlExport = {
296
+ getMlDeployments,
297
+ createMlDeployment,
298
+ deleteMlDeployment,
299
+ getMlDeployment,
300
+ patchMlDeployment,
301
+ activateModelsMlDeployment,
302
+ deactivateModelsMlDeployment,
303
+ getMlDeploymentAliases,
304
+ createMlDeploymentAliase,
305
+ deleteMlDeploymentAliase,
306
+ getMlDeploymentAliase,
307
+ patchMlDeploymentAliase,
308
+ runMlDeploymentAliaseRealtimePredictions,
309
+ getMlDeploymentBatchPredictions,
310
+ createMlDeploymentBatchPrediction,
311
+ deleteMlDeploymentBatchPrediction,
312
+ getMlDeploymentBatchPrediction,
313
+ patchMlDeploymentBatchPrediction,
314
+ predictMlDeploymentBatchPrediction,
315
+ deleteMlDeploymentBatchPredictionSchedule,
316
+ getMlDeploymentBatchPredictionSchedule,
317
+ updateMlDeploymentBatchPredictionSchedule,
318
+ setMlDeploymentBatchPredictionSchedule,
319
+ addMlDeploymentModels,
320
+ removeMlDeploymentModels,
321
+ runMlDeploymentRealtimePredictions,
322
+ getMlExperiments,
323
+ createMlExperiment,
324
+ deleteMlExperiment,
325
+ getMlExperiment,
326
+ patchMlExperiment,
327
+ getMlExperimentModels,
328
+ getMlExperimentModel,
329
+ getMlExperimentVersions,
330
+ createMlExperimentVersion,
331
+ deleteMlExperimentVersion,
332
+ getMlExperimentVersion,
333
+ patchMlExperimentVersion,
334
+ cancelMlJob,
335
+ createMlProfileInsight,
336
+ getMlProfileInsight,
337
+ clearCache
338
+ };
339
+ var ml_default = mlExport;
340
+ export {
341
+ activateModelsMlDeployment,
342
+ addMlDeploymentModels,
343
+ cancelMlJob,
344
+ clearCache,
345
+ createMlDeployment,
346
+ createMlDeploymentAliase,
347
+ createMlDeploymentBatchPrediction,
348
+ createMlExperiment,
349
+ createMlExperimentVersion,
350
+ createMlProfileInsight,
351
+ deactivateModelsMlDeployment,
352
+ ml_default as default,
353
+ deleteMlDeployment,
354
+ deleteMlDeploymentAliase,
355
+ deleteMlDeploymentBatchPrediction,
356
+ deleteMlDeploymentBatchPredictionSchedule,
357
+ deleteMlExperiment,
358
+ deleteMlExperimentVersion,
359
+ getMlDeployment,
360
+ getMlDeploymentAliase,
361
+ getMlDeploymentAliases,
362
+ getMlDeploymentBatchPrediction,
363
+ getMlDeploymentBatchPredictionSchedule,
364
+ getMlDeploymentBatchPredictions,
365
+ getMlDeployments,
366
+ getMlExperiment,
367
+ getMlExperimentModel,
368
+ getMlExperimentModels,
369
+ getMlExperimentVersion,
370
+ getMlExperimentVersions,
371
+ getMlExperiments,
372
+ getMlProfileInsight,
373
+ patchMlDeployment,
374
+ patchMlDeploymentAliase,
375
+ patchMlDeploymentBatchPrediction,
376
+ patchMlExperiment,
377
+ patchMlExperimentVersion,
378
+ predictMlDeploymentBatchPrediction,
379
+ removeMlDeploymentModels,
380
+ runMlDeploymentAliaseRealtimePredictions,
381
+ runMlDeploymentRealtimePredictions,
382
+ setMlDeploymentBatchPredictionSchedule,
383
+ updateMlDeploymentBatchPredictionSchedule
384
+ };
package/notes.d.ts ADDED
@@ -0,0 +1,110 @@
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
+
4
+ /**
5
+ * The possible states for the status of notes configuration GET or POST operation
6
+ */
7
+ type ConfigReasonCode = "deployment" | "toggle" | "license";
8
+ type Error = {
9
+ /** Error code specific to notes broker service. */
10
+ readonly code?: string;
11
+ /** Error cause. */
12
+ readonly detail?: string;
13
+ /** Error title. */
14
+ readonly title?: string;
15
+ };
16
+ /**
17
+ * @example
18
+ * {
19
+ * errors: [
20
+ * {
21
+ * code: "HTTP-123",
22
+ * title: "short error message"
23
+ * }
24
+ * ],
25
+ * traceId: "7326ce0d-1946-41d0-b890-609865cc42ea"
26
+ * }
27
+ */
28
+ type Errors = {
29
+ errors?: Error[];
30
+ /** An optional traceId */
31
+ traceId?: string;
32
+ };
33
+ type NoteSettingsPutPayload = {
34
+ /** pass 'true' to enable the note toggle for the tenant, 'false' to disable the toggle (other values are ignore). */
35
+ toggledOn?: boolean;
36
+ };
37
+ type NoteSettingsPutResponse = {
38
+ /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
39
+ toggleOn?: boolean;
40
+ };
41
+ type NotesUserSettings = {
42
+ /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
43
+ available: boolean;
44
+ /** The timestamp for the last time this users notes settings were fetched from downstream services. */
45
+ lastFetch?: string;
46
+ /** The possible states for the status of notes configuration GET or POST operation */
47
+ reason?: ConfigReasonCode;
48
+ };
49
+ /**
50
+ * Get the enablement status of the notes feature set for this tenant and user.
51
+ *
52
+ * @throws GetNotesSettingsHttpError
53
+ */
54
+ declare const getNotesSettings: (options?: ApiCallOptions) => Promise<GetNotesSettingsHttpResponse>;
55
+ type GetNotesSettingsHttpResponse = {
56
+ data: NotesUserSettings;
57
+ headers: Headers;
58
+ status: 200;
59
+ };
60
+ type GetNotesSettingsHttpError = {
61
+ data: Errors;
62
+ headers: Headers;
63
+ status: number;
64
+ };
65
+ /**
66
+ * update the settings
67
+ *
68
+ * @param body an object with the body content
69
+ * @throws SetNotesSettingsHttpError
70
+ */
71
+ declare const setNotesSettings: (body: NoteSettingsPutPayload, options?: ApiCallOptions) => Promise<SetNotesSettingsHttpResponse>;
72
+ type SetNotesSettingsHttpResponse = {
73
+ data: NoteSettingsPutResponse;
74
+ headers: Headers;
75
+ status: 200;
76
+ };
77
+ type SetNotesSettingsHttpError = {
78
+ data: Errors;
79
+ headers: Headers;
80
+ status: number;
81
+ };
82
+ /**
83
+ * Clears the cache for notes api requests.
84
+ */
85
+ declare function clearCache(): void;
86
+ interface NotesAPI {
87
+ /**
88
+ * Get the enablement status of the notes feature set for this tenant and user.
89
+ *
90
+ * @throws GetNotesSettingsHttpError
91
+ */
92
+ getNotesSettings: typeof getNotesSettings;
93
+ /**
94
+ * update the settings
95
+ *
96
+ * @param body an object with the body content
97
+ * @throws SetNotesSettingsHttpError
98
+ */
99
+ setNotesSettings: typeof setNotesSettings;
100
+ /**
101
+ * Clears the cache for notes api requests.
102
+ */
103
+ clearCache: typeof clearCache;
104
+ }
105
+ /**
106
+ * Functions for the notes api
107
+ */
108
+ declare const notesExport: NotesAPI;
109
+
110
+ export { type ConfigReasonCode, type Error, type Errors, type GetNotesSettingsHttpError, type GetNotesSettingsHttpResponse, type NoteSettingsPutPayload, type NoteSettingsPutResponse, type NotesAPI, type NotesUserSettings, type SetNotesSettingsHttpError, type SetNotesSettingsHttpResponse, clearCache, notesExport as default, getNotesSettings, setNotesSettings };
package/notes.js ADDED
@@ -0,0 +1,31 @@
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/VVD2DPKQ.js";
5
+ import "./chunks/LTNGXTXG.js";
6
+ import "./chunks/2ZQ3ZX7F.js";
7
+
8
+ // src/public/rest/notes.ts
9
+ var getNotesSettings = async (options) => invokeFetch("notes", {
10
+ method: "get",
11
+ pathTemplate: "/api/v1/notes/settings",
12
+ options
13
+ });
14
+ var setNotesSettings = async (body, options) => invokeFetch("notes", {
15
+ method: "put",
16
+ pathTemplate: "/api/v1/notes/settings",
17
+ body,
18
+ contentType: "application/json",
19
+ options
20
+ });
21
+ function clearCache() {
22
+ return clearApiCache("notes");
23
+ }
24
+ var notesExport = { getNotesSettings, setNotesSettings, clearCache };
25
+ var notes_default = notesExport;
26
+ export {
27
+ clearCache,
28
+ notes_default as default,
29
+ getNotesSettings,
30
+ setNotesSettings
31
+ };
@@ -0,0 +1,98 @@
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
+
4
+ /**
5
+ * An error object.
6
+ */
7
+ type Error = {
8
+ /** The error code. */
9
+ code: string;
10
+ /** A human-readable explanation specific to this occurrence of the problem. */
11
+ detail?: string;
12
+ /** Summary of the problem. */
13
+ title: string;
14
+ };
15
+ /**
16
+ * Notification result item
17
+ */
18
+ type NotificationItem = {
19
+ /** Indicates if the notification can be managed in the hub. If true, the object will also contain 'subscriptionInfo' object and a 'presentationInfo' object with a non-empty scopes array. */
20
+ isManageableInHub?: boolean;
21
+ /** Indicates if the notification can be subscribed to by users. If true, the object will also contain 'subscriptionInfo' object */
22
+ isSubscribable: boolean;
23
+ /** Notification name pattern that will trigger this notification e.g resource.action */
24
+ notificationNamePattern: string;
25
+ /** Object containing information pertaining to the presentaion of a notification in the UI */
26
+ presentationInfo?: {
27
+ /** Localized, human-readable string representing the name of the notification suitable to use in a UI */
28
+ friendlyName?: string;
29
+ /** Friendly name to be displayed for each scope. */
30
+ scopeFriendlyNames?: Record<string, string>;
31
+ /** Information about the scopes to which this notification applies. Helps determine the placement of the notification in the UI */
32
+ scopes?: string[];
33
+ };
34
+ /** Object indicating what properties to use to subscribe to this notification via the 'Subscriptions' service. For info about its properties, refer to the Subscription sevice's API doc. */
35
+ subscriptionInfo?: {
36
+ action: string;
37
+ resourceId?: string;
38
+ resourceSubType?: string;
39
+ resourceType: string;
40
+ target?: string;
41
+ };
42
+ /** Type of Transport e.g. Email, Notification, Slack message etc... */
43
+ transports: string[];
44
+ };
45
+ /**
46
+ * Object containing array representing list of supported notifications
47
+ */
48
+ type NotificationsObject = {
49
+ /** list of notifications */
50
+ notifications: NotificationItem[];
51
+ };
52
+ /**
53
+ * List all supported notifications
54
+ *
55
+ * @param query an object with query parameters
56
+ * @throws GetNotificationsHttpError
57
+ */
58
+ declare const getNotifications: (query: {
59
+ /** If present, idenfies the language of the returned 'friendlyName' property. */
60
+ locale?: string;
61
+ /** If present, represents the 'manageableInHub' value to filter by. */
62
+ manageableInHub?: true | false;
63
+ /** If present, represents the 'subscribable' value to filter by. */
64
+ subscribable?: true | false;
65
+ }, options?: ApiCallOptions) => Promise<GetNotificationsHttpResponse>;
66
+ type GetNotificationsHttpResponse = {
67
+ data: NotificationsObject;
68
+ headers: Headers;
69
+ status: 200;
70
+ };
71
+ type GetNotificationsHttpError = {
72
+ data: Error;
73
+ headers: Headers;
74
+ status: number;
75
+ };
76
+ /**
77
+ * Clears the cache for notifications api requests.
78
+ */
79
+ declare function clearCache(): void;
80
+ interface NotificationsAPI {
81
+ /**
82
+ * List all supported notifications
83
+ *
84
+ * @param query an object with query parameters
85
+ * @throws GetNotificationsHttpError
86
+ */
87
+ getNotifications: typeof getNotifications;
88
+ /**
89
+ * Clears the cache for notifications api requests.
90
+ */
91
+ clearCache: typeof clearCache;
92
+ }
93
+ /**
94
+ * Functions for the notifications api
95
+ */
96
+ declare const notificationsExport: NotificationsAPI;
97
+
98
+ export { type Error, type GetNotificationsHttpError, type GetNotificationsHttpResponse, type NotificationItem, type NotificationsAPI, type NotificationsObject, clearCache, notificationsExport as default, getNotifications };
@@ -0,0 +1,24 @@
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/VVD2DPKQ.js";
5
+ import "./chunks/LTNGXTXG.js";
6
+ import "./chunks/2ZQ3ZX7F.js";
7
+
8
+ // src/public/rest/notifications.ts
9
+ var getNotifications = async (query, options) => invokeFetch("notifications", {
10
+ method: "get",
11
+ pathTemplate: "/api/v1/notifications",
12
+ query,
13
+ options
14
+ });
15
+ function clearCache() {
16
+ return clearApiCache("notifications");
17
+ }
18
+ var notificationsExport = { getNotifications, clearCache };
19
+ var notifications_default = notificationsExport;
20
+ export {
21
+ clearCache,
22
+ notifications_default as default,
23
+ getNotifications
24
+ };
package/oauth-clients.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/YKZ2QYHN.js";
5
- import "./chunks/DLKLPD7T.js";
4
+ } from "./chunks/VVD2DPKQ.js";
5
+ import "./chunks/LTNGXTXG.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/oauth-clients.ts