@qlik/api 1.31.0 → 1.33.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/api-keys.d.ts +10 -10
- package/api-keys.js +64 -50
- package/apps.d.ts +56 -56
- package/apps.js +392 -304
- package/assistants.d.ts +1301 -0
- package/assistants.js +329 -0
- package/audits.d.ts +10 -10
- package/audits.js +48 -36
- package/{auth-types-DqfMuSRX.d.ts → auth-types-Cj5bM3Yk.d.ts} +29 -9
- package/auth.d.ts +17 -4
- package/auth.js +4 -2
- package/automation-connections.d.ts +366 -0
- package/automation-connections.js +107 -0
- package/automations.d.ts +27 -27
- package/automations.js +159 -123
- package/automl-deployments.d.ts +97 -0
- package/automl-deployments.js +29 -0
- package/automl-predictions.d.ts +214 -0
- package/automl-predictions.js +84 -0
- package/brands.d.ts +18 -18
- package/brands.js +107 -83
- package/chunks/{KBSD75QL.js → 33GQY7N7.js} +1 -1
- package/chunks/{M64RLKVG.js → 62DXIH3S.js} +7 -5
- package/chunks/7MMXU6EL.js +86 -0
- package/chunks/{DLKLPD7T.js → GPRUNZV4.js} +3 -3
- package/chunks/{YKZ2QYHN.js → LIEZG7IM.js} +3 -3
- package/chunks/{FKDGGR2O.js → OTIO4SEJ.js} +698 -708
- package/chunks/{UZTIZ4H5.js → RP3EJGHG.js} +74 -74
- package/chunks/{GUU3KZGK.js → SPATCXXU.js} +9 -2
- package/chunks/{LY7RP2HA.js → XF3TPZKZ.js} +23 -8
- package/chunks/{6ZONDHRN.js → YYZCS5PW.js} +11 -4
- package/chunks/{3RGGGGAR.js → ZCTVPXGO.js} +1 -1
- package/collections.d.ts +16 -15
- package/collections.js +98 -76
- package/conditions.d.ts +662 -0
- package/conditions.js +135 -0
- package/consumption.d.ts +182 -0
- package/consumption.js +26 -0
- package/csp-origins.d.ts +9 -9
- package/csp-origins.js +53 -41
- package/csrf-token.d.ts +62 -0
- package/csrf-token.js +25 -0
- package/data-alerts.d.ts +1004 -0
- package/data-alerts.js +187 -0
- package/data-assets.d.ts +8 -8
- package/data-assets.js +50 -40
- package/data-connections.d.ts +16 -16
- package/data-connections.js +87 -69
- package/data-credentials.d.ts +11 -11
- package/data-credentials.js +52 -42
- package/data-files.d.ts +18 -18
- package/data-files.js +107 -83
- package/data-qualities.d.ts +175 -0
- package/data-qualities.js +50 -0
- package/data-sets.d.ts +424 -0
- package/data-sets.js +87 -0
- package/data-sources.d.ts +268 -0
- package/data-sources.js +45 -0
- package/data-stores.d.ts +537 -0
- package/data-stores.js +128 -0
- package/dcaas.d.ts +192 -0
- package/dcaas.js +45 -0
- package/di-projects.d.ts +673 -0
- package/di-projects.js +196 -0
- package/direct-access-agents.d.ts +328 -0
- package/direct-access-agents.js +108 -0
- package/encryption.d.ts +370 -0
- package/encryption.js +118 -0
- package/extensions.d.ts +11 -11
- package/extensions.js +61 -47
- package/glossaries.d.ts +33 -33
- package/glossaries.js +221 -173
- package/groups.d.ts +12 -12
- package/groups.js +72 -56
- package/identity-providers.d.ts +11 -11
- package/identity-providers.js +67 -51
- package/index.d.ts +113 -4
- package/index.js +626 -40
- package/interceptors.d.ts +9 -2
- package/interceptors.js +2 -2
- package/invoke-fetch-types-BYCD4pc9.d.ts +98 -0
- package/items.d.ts +14 -13
- package/items.js +71 -55
- package/knowledgebases.d.ts +890 -0
- package/knowledgebases.js +203 -0
- package/licenses.d.ts +14 -14
- package/licenses.js +76 -58
- package/lineage-graphs.d.ts +712 -0
- package/lineage-graphs.js +108 -0
- package/ml.d.ts +2676 -0
- package/ml.js +477 -0
- package/notes.d.ts +110 -0
- package/notes.js +35 -0
- package/notifications.d.ts +98 -0
- package/notifications.js +26 -0
- package/oauth-clients.d.ts +14 -14
- package/oauth-clients.js +96 -74
- package/oauth-tokens.d.ts +126 -0
- package/oauth-tokens.js +35 -0
- package/package.json +34 -6
- package/qix.d.ts +145 -4
- package/qix.js +2 -2
- package/questions.d.ts +364 -0
- package/questions.js +38 -0
- package/quotas.d.ts +6 -6
- package/quotas.js +20 -16
- package/reload-tasks.d.ts +8 -8
- package/reload-tasks.js +46 -36
- package/reloads.d.ts +7 -7
- package/reloads.js +36 -28
- package/report-templates.d.ts +287 -0
- package/report-templates.js +94 -0
- package/reports.d.ts +4 -4
- package/reports.js +20 -16
- package/roles.d.ts +8 -8
- package/roles.js +46 -36
- package/sharing-tasks.d.ts +952 -0
- package/sharing-tasks.js +125 -0
- package/spaces.d.ts +22 -22
- package/spaces.js +153 -119
- package/tasks.d.ts +564 -0
- package/tasks.js +126 -0
- package/temp-contents.d.ts +7 -7
- package/temp-contents.js +30 -24
- package/tenants.d.ts +8 -8
- package/tenants.js +57 -45
- package/themes.d.ts +11 -11
- package/themes.js +61 -47
- package/transports.d.ts +8 -8
- package/transports.js +49 -37
- package/ui-config.d.ts +274 -0
- package/ui-config.js +91 -0
- package/users.d.ts +15 -15
- package/users.js +81 -63
- package/web-integrations.d.ts +8 -8
- package/web-integrations.js +46 -36
- package/web-notifications.d.ts +9 -9
- package/web-notifications.js +53 -41
- package/webhooks.d.ts +14 -14
- package/webhooks.js +88 -68
- package/chunks/2ZQ3ZX7F.js +0 -33
- package/invoke-fetch-types-Cq7bjkqn.d.ts +0 -243
|
@@ -0,0 +1,366 @@
|
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
|
|
2
|
+
import './auth-types-Cj5bM3Yk.js';
|
|
3
|
+
|
|
4
|
+
type AutomationConnectionChangeOwnerObject = {
|
|
5
|
+
/** The unique identifier of the new owner. */
|
|
6
|
+
userId?: string;
|
|
7
|
+
};
|
|
8
|
+
type AutomationConnectionChangeSpaceObject = {
|
|
9
|
+
/** The unique identifier of the new space. */
|
|
10
|
+
spaceId?: string;
|
|
11
|
+
};
|
|
12
|
+
type AutomationConnectionCheckObject = {
|
|
13
|
+
/** The connection status of the automation connection. When true, the automation connection is connected. */
|
|
14
|
+
isConnected?: boolean;
|
|
15
|
+
};
|
|
16
|
+
type AutomationConnectionCreationObject = {
|
|
17
|
+
/** The unique identifier of the connector from which the automation connection is created. */
|
|
18
|
+
connectorId: string;
|
|
19
|
+
/** The name of the created automation connection. */
|
|
20
|
+
name?: string;
|
|
21
|
+
params?: AutomationConnectionParamCreateObject[];
|
|
22
|
+
/** The unique identifier of the space in which the automation connection is created. */
|
|
23
|
+
spaceId?: string;
|
|
24
|
+
};
|
|
25
|
+
type AutomationConnectionDetailObject = {
|
|
26
|
+
/** The unique identifier of the automation connector. */
|
|
27
|
+
connectorId?: string;
|
|
28
|
+
/** The timestamp when the automation connection was created. */
|
|
29
|
+
createdAt?: string;
|
|
30
|
+
/** This contains the error message if a connection is being created with an issue. */
|
|
31
|
+
error?: unknown;
|
|
32
|
+
/** The unique identifier of the automation connection. */
|
|
33
|
+
id?: string;
|
|
34
|
+
/** The connection status of the automation connection. When true, the automation connection is connected. */
|
|
35
|
+
isConnected?: boolean;
|
|
36
|
+
/** The name of the automation connection. */
|
|
37
|
+
name?: string;
|
|
38
|
+
/** The name of the OAuth account associated with the automation connection. */
|
|
39
|
+
oauthAccountName?: string;
|
|
40
|
+
/** The unique identifier of the owner of the automation connection. */
|
|
41
|
+
ownerId?: string;
|
|
42
|
+
params?: AutomationConnectionParamObject[];
|
|
43
|
+
/** The redirect of the OAuth account. */
|
|
44
|
+
redirect?: string;
|
|
45
|
+
/** The space ID of the automation connection. */
|
|
46
|
+
spaceId?: string;
|
|
47
|
+
/** The timestamp when the automation connection was updated. */
|
|
48
|
+
updatedAt?: string;
|
|
49
|
+
};
|
|
50
|
+
type AutomationConnectionParamCreateObject = {
|
|
51
|
+
/** The name of the automation connection parameter. */
|
|
52
|
+
name?: string;
|
|
53
|
+
/** The value of the automation connection parameter option. */
|
|
54
|
+
value?: string;
|
|
55
|
+
};
|
|
56
|
+
type AutomationConnectionParamObject = {
|
|
57
|
+
/** The documentation of the automation connection parameter. */
|
|
58
|
+
documentation?: string;
|
|
59
|
+
/** The example value of the automation connection parameter. */
|
|
60
|
+
exampleValue?: string;
|
|
61
|
+
/** The field type of the automation connection parameter. */
|
|
62
|
+
fieldType?: string;
|
|
63
|
+
/** The unique identifier of the automation connection parameter. */
|
|
64
|
+
id?: string;
|
|
65
|
+
/** When true, the parameter is optional. */
|
|
66
|
+
isOptional?: boolean;
|
|
67
|
+
/** The metadata of the automation connection parameter. */
|
|
68
|
+
meta?: unknown[];
|
|
69
|
+
/** The name of the automation connection parameter. */
|
|
70
|
+
name?: string;
|
|
71
|
+
/** The order that the automation connection configuration fields should be displayed in. */
|
|
72
|
+
order?: number;
|
|
73
|
+
paramOptions?: AutomationConnectionParamOptionObject[];
|
|
74
|
+
/** The value of the automation connection parameter. */
|
|
75
|
+
value?: string;
|
|
76
|
+
};
|
|
77
|
+
type AutomationConnectionParamOptionObject = {
|
|
78
|
+
/** The unique identifier of the automation connection parameter option. */
|
|
79
|
+
id?: string;
|
|
80
|
+
/** The value of the automation connection parameter option. */
|
|
81
|
+
value?: string;
|
|
82
|
+
};
|
|
83
|
+
type AutomationConnectionParamPutObject = {
|
|
84
|
+
/** The unique identifier of the automation connection parameter option. */
|
|
85
|
+
id?: string;
|
|
86
|
+
/** The value of the automation connection parameter option. */
|
|
87
|
+
value?: string;
|
|
88
|
+
};
|
|
89
|
+
type AutomationConnectionPutRequestObject = {
|
|
90
|
+
/** The new name of the automation connection to be renamed to. */
|
|
91
|
+
name?: string;
|
|
92
|
+
params?: AutomationConnectionParamPutObject[];
|
|
93
|
+
};
|
|
94
|
+
type AutomationConnectionsList = {
|
|
95
|
+
data?: AutomationConnectionsListObject[];
|
|
96
|
+
links?: Links;
|
|
97
|
+
};
|
|
98
|
+
type AutomationConnectionsListObject = {
|
|
99
|
+
/** The unique identifier of the connector the automation connection is created from. */
|
|
100
|
+
connectorId?: string;
|
|
101
|
+
/** The timestamp when the automation connection is created. */
|
|
102
|
+
createdAt?: string;
|
|
103
|
+
/** The unique identifier of an automation connection. */
|
|
104
|
+
id?: string;
|
|
105
|
+
/** Returns true if the automtion connection is connected. */
|
|
106
|
+
isConnected?: boolean;
|
|
107
|
+
/** The name of an automation connection. */
|
|
108
|
+
name?: string;
|
|
109
|
+
/** The unique identifier of the owner of the automation connection. */
|
|
110
|
+
ownerId?: string;
|
|
111
|
+
/** The space ID of the automation connection. */
|
|
112
|
+
spaceId?: string;
|
|
113
|
+
/** The timestamp when the automation connection is updated. */
|
|
114
|
+
updatedAt?: string;
|
|
115
|
+
};
|
|
116
|
+
type Error = {
|
|
117
|
+
/** The unique code for the error */
|
|
118
|
+
code: string;
|
|
119
|
+
/** May be used to provide additional details */
|
|
120
|
+
detail?: string;
|
|
121
|
+
/** A summary of what went wrong */
|
|
122
|
+
title: string;
|
|
123
|
+
};
|
|
124
|
+
type ErrorResponse = {
|
|
125
|
+
errors?: Error[];
|
|
126
|
+
/** A way to trace the source of the error. */
|
|
127
|
+
traceId?: string;
|
|
128
|
+
};
|
|
129
|
+
type Links = {
|
|
130
|
+
next?: PaginationLink;
|
|
131
|
+
prev?: PaginationLink;
|
|
132
|
+
};
|
|
133
|
+
type PaginationLink = {
|
|
134
|
+
/** The URL to a resource request */
|
|
135
|
+
href?: string;
|
|
136
|
+
};
|
|
137
|
+
/**
|
|
138
|
+
* Retrieves a list of automation connections
|
|
139
|
+
*
|
|
140
|
+
* @param query an object with query parameters
|
|
141
|
+
* @throws GetAutomationConnectionsHttpError
|
|
142
|
+
*/
|
|
143
|
+
declare function getAutomationConnections(query: {
|
|
144
|
+
/** Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId. */
|
|
145
|
+
filter?: string;
|
|
146
|
+
/** The number of automation connections to retrieve. */
|
|
147
|
+
limit?: number;
|
|
148
|
+
/** When true, list all connections. Restricted to tenant admins and analytics admins. */
|
|
149
|
+
listAll?: boolean;
|
|
150
|
+
/** The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order) */
|
|
151
|
+
sort?: "id" | "name" | "createdAt" | "updatedAt" | "+id" | "+name" | "+createdAt" | "+updatedAt" | "-id" | "-name" | "-createdAt" | "-updatedAt";
|
|
152
|
+
}, options?: ApiCallOptions): Promise<GetAutomationConnectionsHttpResponse>;
|
|
153
|
+
type GetAutomationConnectionsHttpResponse = {
|
|
154
|
+
data: AutomationConnectionsList;
|
|
155
|
+
headers: Headers;
|
|
156
|
+
status: 200;
|
|
157
|
+
prev?: (options?: ApiCallOptions) => Promise<GetAutomationConnectionsHttpResponse>;
|
|
158
|
+
next?: (options?: ApiCallOptions) => Promise<GetAutomationConnectionsHttpResponse>;
|
|
159
|
+
};
|
|
160
|
+
type GetAutomationConnectionsHttpError = {
|
|
161
|
+
data: ErrorResponse;
|
|
162
|
+
headers: Headers;
|
|
163
|
+
status: 400 | 401 | 403 | 500 | 503;
|
|
164
|
+
};
|
|
165
|
+
/**
|
|
166
|
+
* Creates a new connection object from an automation connector.
|
|
167
|
+
*
|
|
168
|
+
* @param body an object with the body content
|
|
169
|
+
* @throws CreateAutomationConnectionHttpError
|
|
170
|
+
*/
|
|
171
|
+
declare function createAutomationConnection(body: AutomationConnectionCreationObject, options?: ApiCallOptions): Promise<CreateAutomationConnectionHttpResponse>;
|
|
172
|
+
type CreateAutomationConnectionHttpResponse = {
|
|
173
|
+
data: AutomationConnectionDetailObject;
|
|
174
|
+
headers: Headers;
|
|
175
|
+
status: 201;
|
|
176
|
+
};
|
|
177
|
+
type CreateAutomationConnectionHttpError = {
|
|
178
|
+
data: ErrorResponse;
|
|
179
|
+
headers: Headers;
|
|
180
|
+
status: 400 | 401 | 403 | 500 | 503;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Deletes the specified automation connection.
|
|
184
|
+
*
|
|
185
|
+
* @param id The unique identifier for the automation connection.
|
|
186
|
+
* @param query an object with query parameters
|
|
187
|
+
* @throws DeleteAutomationConnectionHttpError
|
|
188
|
+
*/
|
|
189
|
+
declare function deleteAutomationConnection(id: string, query: {
|
|
190
|
+
/** When true, the automation connection will be deleted regardless of its usage by any automations. */
|
|
191
|
+
forced?: boolean;
|
|
192
|
+
}, options?: ApiCallOptions): Promise<DeleteAutomationConnectionHttpResponse>;
|
|
193
|
+
type DeleteAutomationConnectionHttpResponse = {
|
|
194
|
+
data: void;
|
|
195
|
+
headers: Headers;
|
|
196
|
+
status: 204;
|
|
197
|
+
};
|
|
198
|
+
type DeleteAutomationConnectionHttpError = {
|
|
199
|
+
data: ErrorResponse;
|
|
200
|
+
headers: Headers;
|
|
201
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
202
|
+
};
|
|
203
|
+
/**
|
|
204
|
+
* Returns details about the specified automation connection.
|
|
205
|
+
*
|
|
206
|
+
* @param id The unique identifier for the automation connection.
|
|
207
|
+
* @throws GetAutomationConnectionHttpError
|
|
208
|
+
*/
|
|
209
|
+
declare function getAutomationConnection(id: string, options?: ApiCallOptions): Promise<GetAutomationConnectionHttpResponse>;
|
|
210
|
+
type GetAutomationConnectionHttpResponse = {
|
|
211
|
+
data: AutomationConnectionDetailObject;
|
|
212
|
+
headers: Headers;
|
|
213
|
+
status: 200;
|
|
214
|
+
};
|
|
215
|
+
type GetAutomationConnectionHttpError = {
|
|
216
|
+
data: ErrorResponse;
|
|
217
|
+
headers: Headers;
|
|
218
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
219
|
+
};
|
|
220
|
+
/**
|
|
221
|
+
* Updates the specified properties of an automation connection.
|
|
222
|
+
*
|
|
223
|
+
* @param id The unique identifier for the automation connection.
|
|
224
|
+
* @param body an object with the body content
|
|
225
|
+
* @throws UpdateAutomationConnectionHttpError
|
|
226
|
+
*/
|
|
227
|
+
declare function updateAutomationConnection(id: string, body: AutomationConnectionPutRequestObject, options?: ApiCallOptions): Promise<UpdateAutomationConnectionHttpResponse>;
|
|
228
|
+
type UpdateAutomationConnectionHttpResponse = {
|
|
229
|
+
data: AutomationConnectionDetailObject;
|
|
230
|
+
headers: Headers;
|
|
231
|
+
status: 200;
|
|
232
|
+
};
|
|
233
|
+
type UpdateAutomationConnectionHttpError = {
|
|
234
|
+
data: ErrorResponse;
|
|
235
|
+
headers: Headers;
|
|
236
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
237
|
+
};
|
|
238
|
+
/**
|
|
239
|
+
* Changes the owner of an automation connection by specifying a new owner.
|
|
240
|
+
*
|
|
241
|
+
* @param id The unique identifier for the automation connection.
|
|
242
|
+
* @param body an object with the body content
|
|
243
|
+
* @throws ChangeOwnerAutomationConnectionHttpError
|
|
244
|
+
*/
|
|
245
|
+
declare function changeOwnerAutomationConnection(id: string, body: AutomationConnectionChangeOwnerObject, options?: ApiCallOptions): Promise<ChangeOwnerAutomationConnectionHttpResponse>;
|
|
246
|
+
type ChangeOwnerAutomationConnectionHttpResponse = {
|
|
247
|
+
data: void;
|
|
248
|
+
headers: Headers;
|
|
249
|
+
status: 204;
|
|
250
|
+
};
|
|
251
|
+
type ChangeOwnerAutomationConnectionHttpError = {
|
|
252
|
+
data: ErrorResponse;
|
|
253
|
+
headers: Headers;
|
|
254
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
255
|
+
};
|
|
256
|
+
/**
|
|
257
|
+
* Changes the space of an automation connection by specifying a new space.
|
|
258
|
+
*
|
|
259
|
+
* @param id The unique identifier for the automation connection.
|
|
260
|
+
* @param body an object with the body content
|
|
261
|
+
* @throws ChangeSpaceAutomationConnectionHttpError
|
|
262
|
+
*/
|
|
263
|
+
declare function changeSpaceAutomationConnection(id: string, body: AutomationConnectionChangeSpaceObject, options?: ApiCallOptions): Promise<ChangeSpaceAutomationConnectionHttpResponse>;
|
|
264
|
+
type ChangeSpaceAutomationConnectionHttpResponse = {
|
|
265
|
+
data: void;
|
|
266
|
+
headers: Headers;
|
|
267
|
+
status: 204;
|
|
268
|
+
};
|
|
269
|
+
type ChangeSpaceAutomationConnectionHttpError = {
|
|
270
|
+
data: ErrorResponse;
|
|
271
|
+
headers: Headers;
|
|
272
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* Tries to validate and checks the connection status of an automation connection.
|
|
276
|
+
*
|
|
277
|
+
* @param id The unique identifier for the automation connection.
|
|
278
|
+
* @throws CheckAutomationConnectionHttpError
|
|
279
|
+
*/
|
|
280
|
+
declare function checkAutomationConnection(id: string, options?: ApiCallOptions): Promise<CheckAutomationConnectionHttpResponse>;
|
|
281
|
+
type CheckAutomationConnectionHttpResponse = {
|
|
282
|
+
data: AutomationConnectionCheckObject;
|
|
283
|
+
headers: Headers;
|
|
284
|
+
status: 200;
|
|
285
|
+
};
|
|
286
|
+
type CheckAutomationConnectionHttpError = {
|
|
287
|
+
data: ErrorResponse;
|
|
288
|
+
headers: Headers;
|
|
289
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
290
|
+
};
|
|
291
|
+
/**
|
|
292
|
+
* Clears the cache for automation-connections api requests.
|
|
293
|
+
*/
|
|
294
|
+
declare function clearCache(): void;
|
|
295
|
+
interface AutomationConnectionsAPI {
|
|
296
|
+
/**
|
|
297
|
+
* Retrieves a list of automation connections
|
|
298
|
+
*
|
|
299
|
+
* @param query an object with query parameters
|
|
300
|
+
* @throws GetAutomationConnectionsHttpError
|
|
301
|
+
*/
|
|
302
|
+
getAutomationConnections: typeof getAutomationConnections;
|
|
303
|
+
/**
|
|
304
|
+
* Creates a new connection object from an automation connector.
|
|
305
|
+
*
|
|
306
|
+
* @param body an object with the body content
|
|
307
|
+
* @throws CreateAutomationConnectionHttpError
|
|
308
|
+
*/
|
|
309
|
+
createAutomationConnection: typeof createAutomationConnection;
|
|
310
|
+
/**
|
|
311
|
+
* Deletes the specified automation connection.
|
|
312
|
+
*
|
|
313
|
+
* @param id The unique identifier for the automation connection.
|
|
314
|
+
* @param query an object with query parameters
|
|
315
|
+
* @throws DeleteAutomationConnectionHttpError
|
|
316
|
+
*/
|
|
317
|
+
deleteAutomationConnection: typeof deleteAutomationConnection;
|
|
318
|
+
/**
|
|
319
|
+
* Returns details about the specified automation connection.
|
|
320
|
+
*
|
|
321
|
+
* @param id The unique identifier for the automation connection.
|
|
322
|
+
* @throws GetAutomationConnectionHttpError
|
|
323
|
+
*/
|
|
324
|
+
getAutomationConnection: typeof getAutomationConnection;
|
|
325
|
+
/**
|
|
326
|
+
* Updates the specified properties of an automation connection.
|
|
327
|
+
*
|
|
328
|
+
* @param id The unique identifier for the automation connection.
|
|
329
|
+
* @param body an object with the body content
|
|
330
|
+
* @throws UpdateAutomationConnectionHttpError
|
|
331
|
+
*/
|
|
332
|
+
updateAutomationConnection: typeof updateAutomationConnection;
|
|
333
|
+
/**
|
|
334
|
+
* Changes the owner of an automation connection by specifying a new owner.
|
|
335
|
+
*
|
|
336
|
+
* @param id The unique identifier for the automation connection.
|
|
337
|
+
* @param body an object with the body content
|
|
338
|
+
* @throws ChangeOwnerAutomationConnectionHttpError
|
|
339
|
+
*/
|
|
340
|
+
changeOwnerAutomationConnection: typeof changeOwnerAutomationConnection;
|
|
341
|
+
/**
|
|
342
|
+
* Changes the space of an automation connection by specifying a new space.
|
|
343
|
+
*
|
|
344
|
+
* @param id The unique identifier for the automation connection.
|
|
345
|
+
* @param body an object with the body content
|
|
346
|
+
* @throws ChangeSpaceAutomationConnectionHttpError
|
|
347
|
+
*/
|
|
348
|
+
changeSpaceAutomationConnection: typeof changeSpaceAutomationConnection;
|
|
349
|
+
/**
|
|
350
|
+
* Tries to validate and checks the connection status of an automation connection.
|
|
351
|
+
*
|
|
352
|
+
* @param id The unique identifier for the automation connection.
|
|
353
|
+
* @throws CheckAutomationConnectionHttpError
|
|
354
|
+
*/
|
|
355
|
+
checkAutomationConnection: typeof checkAutomationConnection;
|
|
356
|
+
/**
|
|
357
|
+
* Clears the cache for automation-connections api requests.
|
|
358
|
+
*/
|
|
359
|
+
clearCache: typeof clearCache;
|
|
360
|
+
}
|
|
361
|
+
/**
|
|
362
|
+
* Functions for the automation-connections api
|
|
363
|
+
*/
|
|
364
|
+
declare const automationConnectionsExport: AutomationConnectionsAPI;
|
|
365
|
+
|
|
366
|
+
export { type AutomationConnectionChangeOwnerObject, type AutomationConnectionChangeSpaceObject, type AutomationConnectionCheckObject, type AutomationConnectionCreationObject, type AutomationConnectionDetailObject, type AutomationConnectionParamCreateObject, type AutomationConnectionParamObject, type AutomationConnectionParamOptionObject, type AutomationConnectionParamPutObject, type AutomationConnectionPutRequestObject, type AutomationConnectionsAPI, type AutomationConnectionsList, type AutomationConnectionsListObject, type ChangeOwnerAutomationConnectionHttpError, type ChangeOwnerAutomationConnectionHttpResponse, type ChangeSpaceAutomationConnectionHttpError, type ChangeSpaceAutomationConnectionHttpResponse, type CheckAutomationConnectionHttpError, type CheckAutomationConnectionHttpResponse, type CreateAutomationConnectionHttpError, type CreateAutomationConnectionHttpResponse, type DeleteAutomationConnectionHttpError, type DeleteAutomationConnectionHttpResponse, type Error, type ErrorResponse, type GetAutomationConnectionHttpError, type GetAutomationConnectionHttpResponse, type GetAutomationConnectionsHttpError, type GetAutomationConnectionsHttpResponse, type Links, type PaginationLink, type UpdateAutomationConnectionHttpError, type UpdateAutomationConnectionHttpResponse, changeOwnerAutomationConnection, changeSpaceAutomationConnection, checkAutomationConnection, clearCache, createAutomationConnection, automationConnectionsExport as default, deleteAutomationConnection, getAutomationConnection, getAutomationConnections, updateAutomationConnection };
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import {
|
|
2
|
+
clearApiCache,
|
|
3
|
+
invokeFetch
|
|
4
|
+
} from "./chunks/LIEZG7IM.js";
|
|
5
|
+
import "./chunks/GPRUNZV4.js";
|
|
6
|
+
import "./chunks/7MMXU6EL.js";
|
|
7
|
+
|
|
8
|
+
// src/public/rest/automation-connections.ts
|
|
9
|
+
async function getAutomationConnections(query, options) {
|
|
10
|
+
return invokeFetch("automation-connections", {
|
|
11
|
+
method: "get",
|
|
12
|
+
pathTemplate: "/api/v1/automation-connections",
|
|
13
|
+
query,
|
|
14
|
+
options
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
async function createAutomationConnection(body, options) {
|
|
18
|
+
return invokeFetch("automation-connections", {
|
|
19
|
+
method: "post",
|
|
20
|
+
pathTemplate: "/api/v1/automation-connections",
|
|
21
|
+
body,
|
|
22
|
+
contentType: "application/json",
|
|
23
|
+
options
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
async function deleteAutomationConnection(id, query, options) {
|
|
27
|
+
return invokeFetch("automation-connections", {
|
|
28
|
+
method: "delete",
|
|
29
|
+
pathTemplate: "/api/v1/automation-connections/{id}",
|
|
30
|
+
pathVariables: { id },
|
|
31
|
+
query,
|
|
32
|
+
options
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
async function getAutomationConnection(id, options) {
|
|
36
|
+
return invokeFetch("automation-connections", {
|
|
37
|
+
method: "get",
|
|
38
|
+
pathTemplate: "/api/v1/automation-connections/{id}",
|
|
39
|
+
pathVariables: { id },
|
|
40
|
+
options
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
async function updateAutomationConnection(id, body, options) {
|
|
44
|
+
return invokeFetch("automation-connections", {
|
|
45
|
+
method: "put",
|
|
46
|
+
pathTemplate: "/api/v1/automation-connections/{id}",
|
|
47
|
+
pathVariables: { id },
|
|
48
|
+
body,
|
|
49
|
+
contentType: "application/json",
|
|
50
|
+
options
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
async function changeOwnerAutomationConnection(id, body, options) {
|
|
54
|
+
return invokeFetch("automation-connections", {
|
|
55
|
+
method: "post",
|
|
56
|
+
pathTemplate: "/api/v1/automation-connections/{id}/actions/change-owner",
|
|
57
|
+
pathVariables: { id },
|
|
58
|
+
body,
|
|
59
|
+
contentType: "application/json",
|
|
60
|
+
options
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
async function changeSpaceAutomationConnection(id, body, options) {
|
|
64
|
+
return invokeFetch("automation-connections", {
|
|
65
|
+
method: "post",
|
|
66
|
+
pathTemplate: "/api/v1/automation-connections/{id}/actions/change-space",
|
|
67
|
+
pathVariables: { id },
|
|
68
|
+
body,
|
|
69
|
+
contentType: "application/json",
|
|
70
|
+
options
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
async function checkAutomationConnection(id, options) {
|
|
74
|
+
return invokeFetch("automation-connections", {
|
|
75
|
+
method: "post",
|
|
76
|
+
pathTemplate: "/api/v1/automation-connections/{id}/actions/check",
|
|
77
|
+
pathVariables: { id },
|
|
78
|
+
options
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
function clearCache() {
|
|
82
|
+
return clearApiCache("automation-connections");
|
|
83
|
+
}
|
|
84
|
+
var automationConnectionsExport = {
|
|
85
|
+
getAutomationConnections,
|
|
86
|
+
createAutomationConnection,
|
|
87
|
+
deleteAutomationConnection,
|
|
88
|
+
getAutomationConnection,
|
|
89
|
+
updateAutomationConnection,
|
|
90
|
+
changeOwnerAutomationConnection,
|
|
91
|
+
changeSpaceAutomationConnection,
|
|
92
|
+
checkAutomationConnection,
|
|
93
|
+
clearCache
|
|
94
|
+
};
|
|
95
|
+
var automation_connections_default = automationConnectionsExport;
|
|
96
|
+
export {
|
|
97
|
+
changeOwnerAutomationConnection,
|
|
98
|
+
changeSpaceAutomationConnection,
|
|
99
|
+
checkAutomationConnection,
|
|
100
|
+
clearCache,
|
|
101
|
+
createAutomationConnection,
|
|
102
|
+
automation_connections_default as default,
|
|
103
|
+
deleteAutomationConnection,
|
|
104
|
+
getAutomationConnection,
|
|
105
|
+
getAutomationConnections,
|
|
106
|
+
updateAutomationConnection
|
|
107
|
+
};
|
package/automations.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './invoke-fetch-types-
|
|
2
|
-
import './auth-types-
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
|
|
2
|
+
import './auth-types-Cj5bM3Yk.js';
|
|
3
3
|
|
|
4
4
|
type AutomationDetailRequestObject = {
|
|
5
5
|
description?: string;
|
|
@@ -199,7 +199,7 @@ type UsageObject = {
|
|
|
199
199
|
* @param query an object with query parameters
|
|
200
200
|
* @throws GetAutomationsHttpError
|
|
201
201
|
*/
|
|
202
|
-
declare
|
|
202
|
+
declare function getAutomations(query: {
|
|
203
203
|
/** Allows to select the actual fields to be returned. When no fields are defined, all are returned. */
|
|
204
204
|
fields?: string;
|
|
205
205
|
/** Allowed filters: name, runMode, lastRunStatus, ownerId */
|
|
@@ -208,7 +208,7 @@ declare const getAutomations: (query: {
|
|
|
208
208
|
limit?: number;
|
|
209
209
|
/** The field to sort by, with +- prefix indicating sort order. (?query=-name => sort on the name field using descending order) */
|
|
210
210
|
sort?: "id" | "name" | "runMode" | "state" | "createdAt" | "updatedAt" | "lastRunAt" | "lastRunStatus" | "duration" | "+id" | "+name" | "+runMode" | "+state" | "+createdAt" | "+updatedAt" | "+lastRunAt" | "+lastRunStatus" | "-id" | "-name" | "-runMode" | "-state" | "-createdAt" | "-updatedAt" | "-lastRunAt" | "-lastRunStatus" | "+duration" | "-duration";
|
|
211
|
-
}, options?: ApiCallOptions)
|
|
211
|
+
}, options?: ApiCallOptions): Promise<GetAutomationsHttpResponse>;
|
|
212
212
|
type GetAutomationsHttpResponse = {
|
|
213
213
|
data: AutomationList;
|
|
214
214
|
headers: Headers;
|
|
@@ -227,7 +227,7 @@ type GetAutomationsHttpError = {
|
|
|
227
227
|
* @param body an object with the body content
|
|
228
228
|
* @throws CreateAutomationHttpError
|
|
229
229
|
*/
|
|
230
|
-
declare
|
|
230
|
+
declare function createAutomation(body: AutomationDetailRequestObject, options?: ApiCallOptions): Promise<CreateAutomationHttpResponse>;
|
|
231
231
|
type CreateAutomationHttpResponse = {
|
|
232
232
|
data: AutomationDetailResponseObject;
|
|
233
233
|
headers: Headers;
|
|
@@ -244,12 +244,12 @@ type CreateAutomationHttpError = {
|
|
|
244
244
|
* @param query an object with query parameters
|
|
245
245
|
* @throws GetAutomationsUsageMetricsHttpError
|
|
246
246
|
*/
|
|
247
|
-
declare
|
|
247
|
+
declare function getAutomationsUsageMetrics(query: {
|
|
248
248
|
/** If specified, result will be broken apart for each automation */
|
|
249
249
|
breakdownBy?: string;
|
|
250
250
|
/** Indicates how the metrics should be filtered */
|
|
251
251
|
filter: string;
|
|
252
|
-
}, options?: ApiCallOptions)
|
|
252
|
+
}, options?: ApiCallOptions): Promise<GetAutomationsUsageMetricsHttpResponse>;
|
|
253
253
|
type GetAutomationsUsageMetricsHttpResponse = {
|
|
254
254
|
data: UsageList;
|
|
255
255
|
headers: Headers;
|
|
@@ -268,7 +268,7 @@ type GetAutomationsUsageMetricsHttpError = {
|
|
|
268
268
|
* @param id The unique identifier for the automation.
|
|
269
269
|
* @throws DeleteAutomationHttpError
|
|
270
270
|
*/
|
|
271
|
-
declare
|
|
271
|
+
declare function deleteAutomation(id: string, options?: ApiCallOptions): Promise<DeleteAutomationHttpResponse>;
|
|
272
272
|
type DeleteAutomationHttpResponse = {
|
|
273
273
|
data: void;
|
|
274
274
|
headers: Headers;
|
|
@@ -286,10 +286,10 @@ type DeleteAutomationHttpError = {
|
|
|
286
286
|
* @param query an object with query parameters
|
|
287
287
|
* @throws GetAutomationWithQueryHttpError
|
|
288
288
|
*/
|
|
289
|
-
declare
|
|
289
|
+
declare function getAutomationWithQuery(id: string, query: {
|
|
290
290
|
/** Allows to select the actual fields to be returned. Where the default is all fields */
|
|
291
291
|
fields?: string;
|
|
292
|
-
}, options?: ApiCallOptions)
|
|
292
|
+
}, options?: ApiCallOptions): Promise<GetAutomationWithQueryHttpResponse>;
|
|
293
293
|
type GetAutomationWithQueryHttpResponse = {
|
|
294
294
|
data: AutomationDetailResponseObject;
|
|
295
295
|
headers: Headers;
|
|
@@ -306,7 +306,7 @@ type GetAutomationWithQueryHttpError = {
|
|
|
306
306
|
* @param id The unique identifier for the automation.
|
|
307
307
|
* @throws GetAutomationHttpError
|
|
308
308
|
*/
|
|
309
|
-
declare
|
|
309
|
+
declare function getAutomation(id: string, options?: ApiCallOptions): Promise<GetAutomationHttpResponse>;
|
|
310
310
|
type GetAutomationHttpResponse = {
|
|
311
311
|
data: AutomationDetailResponseObject;
|
|
312
312
|
headers: Headers;
|
|
@@ -324,7 +324,7 @@ type GetAutomationHttpError = {
|
|
|
324
324
|
* @param body an object with the body content
|
|
325
325
|
* @throws UpdateAutomationHttpError
|
|
326
326
|
*/
|
|
327
|
-
declare
|
|
327
|
+
declare function updateAutomation(id: string, body: AutomationDetailRequestObject, options?: ApiCallOptions): Promise<UpdateAutomationHttpResponse>;
|
|
328
328
|
type UpdateAutomationHttpResponse = {
|
|
329
329
|
data: AutomationDetailResponseObject;
|
|
330
330
|
headers: Headers;
|
|
@@ -342,10 +342,10 @@ type UpdateAutomationHttpError = {
|
|
|
342
342
|
* @param body an object with the body content
|
|
343
343
|
* @throws CopyAutomationHttpError
|
|
344
344
|
*/
|
|
345
|
-
declare
|
|
345
|
+
declare function copyAutomation(id: string, body: {
|
|
346
346
|
/** Name of the new automation. */
|
|
347
347
|
name: string;
|
|
348
|
-
}, options?: ApiCallOptions)
|
|
348
|
+
}, options?: ApiCallOptions): Promise<CopyAutomationHttpResponse>;
|
|
349
349
|
type CopyAutomationHttpResponse = {
|
|
350
350
|
data: {
|
|
351
351
|
/** The unique identifier for the automation. */
|
|
@@ -365,7 +365,7 @@ type CopyAutomationHttpError = {
|
|
|
365
365
|
* @param id The unique identifier for the automation.
|
|
366
366
|
* @throws DisableAutomationHttpError
|
|
367
367
|
*/
|
|
368
|
-
declare
|
|
368
|
+
declare function disableAutomation(id: string, options?: ApiCallOptions): Promise<DisableAutomationHttpResponse>;
|
|
369
369
|
type DisableAutomationHttpResponse = {
|
|
370
370
|
data: void;
|
|
371
371
|
headers: Headers;
|
|
@@ -382,7 +382,7 @@ type DisableAutomationHttpError = {
|
|
|
382
382
|
* @param id The unique identifier for the automation.
|
|
383
383
|
* @throws EnableAutomationHttpError
|
|
384
384
|
*/
|
|
385
|
-
declare
|
|
385
|
+
declare function enableAutomation(id: string, options?: ApiCallOptions): Promise<EnableAutomationHttpResponse>;
|
|
386
386
|
type EnableAutomationHttpResponse = {
|
|
387
387
|
data: void;
|
|
388
388
|
headers: Headers;
|
|
@@ -400,9 +400,9 @@ type EnableAutomationHttpError = {
|
|
|
400
400
|
* @param body an object with the body content
|
|
401
401
|
* @throws MoveAutomationHttpError
|
|
402
402
|
*/
|
|
403
|
-
declare
|
|
403
|
+
declare function moveAutomation(id: string, body: {
|
|
404
404
|
userId: string;
|
|
405
|
-
}, options?: ApiCallOptions)
|
|
405
|
+
}, options?: ApiCallOptions): Promise<MoveAutomationHttpResponse>;
|
|
406
406
|
type MoveAutomationHttpResponse = {
|
|
407
407
|
data: void;
|
|
408
408
|
headers: Headers;
|
|
@@ -420,7 +420,7 @@ type MoveAutomationHttpError = {
|
|
|
420
420
|
* @param query an object with query parameters
|
|
421
421
|
* @throws GetAutomationRunsHttpError
|
|
422
422
|
*/
|
|
423
|
-
declare
|
|
423
|
+
declare function getAutomationRuns(id: string, query: {
|
|
424
424
|
/** Allows to select the actual fields to be returned. Where the default is all fields */
|
|
425
425
|
fields?: string;
|
|
426
426
|
/** Allowed filters: status, context, startTime and title */
|
|
@@ -429,7 +429,7 @@ declare const getAutomationRuns: (id: string, query: {
|
|
|
429
429
|
limit?: number;
|
|
430
430
|
/** The field to sort by, with +- prefix indicating sort order. (?query=-startTime => sort on the startTime field using descending order) */
|
|
431
431
|
sort?: "id" | "status" | "startTime" | "-id" | "-status" | "-startTime" | "+id" | "+status" | "+startTime";
|
|
432
|
-
}, options?: ApiCallOptions)
|
|
432
|
+
}, options?: ApiCallOptions): Promise<GetAutomationRunsHttpResponse>;
|
|
433
433
|
type GetAutomationRunsHttpResponse = {
|
|
434
434
|
data: RunList;
|
|
435
435
|
headers: Headers;
|
|
@@ -449,7 +449,7 @@ type GetAutomationRunsHttpError = {
|
|
|
449
449
|
* @param body an object with the body content
|
|
450
450
|
* @throws QueueAutomationRunHttpError
|
|
451
451
|
*/
|
|
452
|
-
declare
|
|
452
|
+
declare function queueAutomationRun(id: string, body: RunDetailRequestObject, options?: ApiCallOptions): Promise<QueueAutomationRunHttpResponse>;
|
|
453
453
|
type QueueAutomationRunHttpResponse = {
|
|
454
454
|
data: RunDetailResponseObject;
|
|
455
455
|
headers: Headers;
|
|
@@ -468,10 +468,10 @@ type QueueAutomationRunHttpError = {
|
|
|
468
468
|
* @param query an object with query parameters
|
|
469
469
|
* @throws GetAutomationRunWithQueryHttpError
|
|
470
470
|
*/
|
|
471
|
-
declare
|
|
471
|
+
declare function getAutomationRunWithQuery(id: string, runId: string, query: {
|
|
472
472
|
/** Allows to select the actual fields to be returned. Where the default is all fields */
|
|
473
473
|
fields?: string;
|
|
474
|
-
}, options?: ApiCallOptions)
|
|
474
|
+
}, options?: ApiCallOptions): Promise<GetAutomationRunWithQueryHttpResponse>;
|
|
475
475
|
type GetAutomationRunWithQueryHttpResponse = {
|
|
476
476
|
data: RunDetailResponseObject;
|
|
477
477
|
headers: Headers;
|
|
@@ -489,7 +489,7 @@ type GetAutomationRunWithQueryHttpError = {
|
|
|
489
489
|
* @param runId The unique identifier for the run.
|
|
490
490
|
* @throws GetAutomationRunHttpError
|
|
491
491
|
*/
|
|
492
|
-
declare
|
|
492
|
+
declare function getAutomationRun(id: string, runId: string, options?: ApiCallOptions): Promise<GetAutomationRunHttpResponse>;
|
|
493
493
|
type GetAutomationRunHttpResponse = {
|
|
494
494
|
data: RunDetailResponseObject;
|
|
495
495
|
headers: Headers;
|
|
@@ -507,7 +507,7 @@ type GetAutomationRunHttpError = {
|
|
|
507
507
|
* @param runId The unique identifier for the run.
|
|
508
508
|
* @throws GetAutomationRunDetailsHttpError
|
|
509
509
|
*/
|
|
510
|
-
declare
|
|
510
|
+
declare function getAutomationRunDetails(id: string, runId: string, options?: ApiCallOptions): Promise<GetAutomationRunDetailsHttpResponse>;
|
|
511
511
|
type GetAutomationRunDetailsHttpResponse = {
|
|
512
512
|
data: {
|
|
513
513
|
url?: string;
|
|
@@ -527,7 +527,7 @@ type GetAutomationRunDetailsHttpError = {
|
|
|
527
527
|
* @param runId The unique identifier for the run.
|
|
528
528
|
* @throws RetryAutomationRunHttpError
|
|
529
529
|
*/
|
|
530
|
-
declare
|
|
530
|
+
declare function retryAutomationRun(id: string, runId: string, options?: ApiCallOptions): Promise<RetryAutomationRunHttpResponse>;
|
|
531
531
|
type RetryAutomationRunHttpResponse = {
|
|
532
532
|
data: void;
|
|
533
533
|
headers: Headers;
|
|
@@ -545,7 +545,7 @@ type RetryAutomationRunHttpError = {
|
|
|
545
545
|
* @param runId The unique identifier for the run.
|
|
546
546
|
* @throws StopAutomationRunHttpError
|
|
547
547
|
*/
|
|
548
|
-
declare
|
|
548
|
+
declare function stopAutomationRun(id: string, runId: string, options?: ApiCallOptions): Promise<StopAutomationRunHttpResponse>;
|
|
549
549
|
type StopAutomationRunHttpResponse = {
|
|
550
550
|
data: void;
|
|
551
551
|
headers: Headers;
|