@qlik/api 1.32.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 +34 -34
- package/assistants.js +257 -201
- 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 +12 -12
- package/automation-connections.js +75 -59
- package/automations.d.ts +27 -27
- package/automations.js +159 -123
- package/automl-deployments.d.ts +4 -4
- package/automl-deployments.js +14 -12
- package/automl-predictions.d.ts +13 -13
- package/automl-predictions.js +56 -44
- package/brands.d.ts +18 -18
- package/brands.js +107 -83
- package/chunks/{YTT2FEVE.js → 33GQY7N7.js} +1 -1
- package/chunks/{M64RLKVG.js → 62DXIH3S.js} +7 -5
- package/chunks/7MMXU6EL.js +86 -0
- package/chunks/{LTNGXTXG.js → GPRUNZV4.js} +3 -3
- package/chunks/{VVD2DPKQ.js → LIEZG7IM.js} +3 -3
- package/chunks/{FKDGGR2O.js → OTIO4SEJ.js} +698 -708
- package/chunks/{UZTIZ4H5.js → RP3EJGHG.js} +74 -74
- package/chunks/{RCLKKVYB.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 +13 -13
- package/conditions.js +97 -75
- package/consumption.d.ts +4 -4
- package/consumption.js +11 -9
- package/csp-origins.d.ts +9 -9
- package/csp-origins.js +53 -41
- package/csrf-token.d.ts +3 -3
- package/csrf-token.js +10 -8
- package/data-alerts.d.ts +22 -22
- package/data-alerts.js +139 -107
- 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 +6 -6
- package/data-qualities.js +28 -22
- package/data-sets.d.ts +10 -10
- package/data-sets.js +59 -47
- package/data-sources.d.ts +7 -7
- package/data-sources.js +28 -22
- package/data-stores.d.ts +16 -16
- package/data-stores.js +92 -72
- package/dcaas.d.ts +6 -6
- package/dcaas.js +28 -22
- package/di-projects.d.ts +22 -22
- package/di-projects.js +148 -116
- package/direct-access-agents.d.ts +328 -0
- package/direct-access-agents.js +108 -0
- package/encryption.d.ts +12 -12
- package/encryption.js +82 -62
- 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 +9 -4
- package/index.js +101 -67
- 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 +23 -23
- package/knowledgebases.js +153 -119
- package/licenses.d.ts +13 -13
- package/licenses.js +76 -58
- package/lineage-graphs.d.ts +17 -17
- package/lineage-graphs.js +76 -60
- package/ml.d.ts +100 -52
- package/ml.js +379 -286
- package/notes.d.ts +4 -4
- package/notes.js +19 -15
- package/notifications.d.ts +4 -4
- package/notifications.js +11 -9
- package/oauth-clients.d.ts +14 -14
- package/oauth-clients.js +96 -74
- package/oauth-tokens.d.ts +5 -5
- package/oauth-tokens.js +19 -15
- package/package.json +8 -6
- package/qix.d.ts +145 -4
- package/qix.js +2 -2
- package/questions.d.ts +5 -5
- package/questions.js +22 -18
- 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 +10 -10
- package/report-templates.js +64 -50
- 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 +14 -14
- package/sharing-tasks.js +89 -69
- package/spaces.d.ts +22 -22
- package/spaces.js +153 -119
- package/tasks.d.ts +17 -17
- package/tasks.js +90 -70
- 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 +9 -9
- package/ui-config.js +61 -47
- 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
|
@@ -58,8 +58,20 @@ type AuthenticationErrorAction = {
|
|
|
58
58
|
*/
|
|
59
59
|
preventDefault?: boolean;
|
|
60
60
|
};
|
|
61
|
+
/** A typed string array with extracted required properties from a type */
|
|
62
|
+
type RequiredKeys<T> = {
|
|
63
|
+
[K in keyof T]-?: {} extends Pick<T, K> ? never : K;
|
|
64
|
+
}[keyof T];
|
|
65
|
+
/** A typed string array with extracted optional properties from a type */
|
|
66
|
+
type OptionalKeys<T> = {
|
|
67
|
+
[K in keyof T]-?: {} extends Pick<T, K> ? K : never;
|
|
68
|
+
}[keyof T];
|
|
61
69
|
/** An authentication module for a specific authentication format, like oauth, cookies etc */
|
|
62
70
|
type AuthModule<A extends AuthType = AuthType> = {
|
|
71
|
+
/** Properties required for this auth module */
|
|
72
|
+
requiredProps?: RequiredKeys<HostConfig<A>>[];
|
|
73
|
+
/** Properties that are optional for this auth module */
|
|
74
|
+
optionalProps?: OptionalKeys<HostConfig<A>>[];
|
|
63
75
|
/** Get auth params for rest api calls */
|
|
64
76
|
getRestCallAuthParams: (props: GetRestCallAuthParamsProps<A>) => Promise<RestCallAuthParams>;
|
|
65
77
|
/** Get auth params for websocket api calls */
|
|
@@ -77,14 +89,6 @@ type AuthType = keyof QlikAuthModules;
|
|
|
77
89
|
type HostConfig<A extends AuthType = AuthType> = {
|
|
78
90
|
[K in keyof QlikAuthModules]: QlikAuthModuleConfigUnion<K> & HostConfigCommon;
|
|
79
91
|
}[A];
|
|
80
|
-
/** The keys in this interface are used to determine what auth types that are allowed to be set to undefined */
|
|
81
|
-
interface ImplicitQlikAuthModules {
|
|
82
|
-
apikey: object;
|
|
83
|
-
oauth2: object;
|
|
84
|
-
cookie: object;
|
|
85
|
-
reference: object;
|
|
86
|
-
anonymous: object;
|
|
87
|
-
}
|
|
88
92
|
type QlikAuthModuleConfigUnion<K extends keyof QlikAuthModules> = (K extends keyof ImplicitQlikAuthModules ? {
|
|
89
93
|
authType?: K;
|
|
90
94
|
} : {
|
|
@@ -103,5 +107,21 @@ type HostConfigCommon = {
|
|
|
103
107
|
message: string;
|
|
104
108
|
}) => unknown;
|
|
105
109
|
};
|
|
110
|
+
/**
|
|
111
|
+
* These properties are always allowed in the host config, even if they are not defined in the HostConfig interface
|
|
112
|
+
* for the specific auth module.
|
|
113
|
+
*/
|
|
114
|
+
declare const hostConfigCommonProperties: (keyof HostConfig)[];
|
|
115
|
+
/** The keys in this interface are used to determine what auth types that are allowed to be set to undefined */
|
|
116
|
+
interface ImplicitQlikAuthModules {
|
|
117
|
+
apikey: object;
|
|
118
|
+
oauth2: object;
|
|
119
|
+
cookie: object;
|
|
120
|
+
windowscookie: object;
|
|
121
|
+
reference: object;
|
|
122
|
+
anonymous: object;
|
|
123
|
+
}
|
|
124
|
+
type AuthTypeThatCanBeOmitted = keyof ImplicitQlikAuthModules;
|
|
125
|
+
declare const authTypesThatCanBeOmitted: AuthTypeThatCanBeOmitted[];
|
|
106
126
|
|
|
107
|
-
export type
|
|
127
|
+
export { type AuthType as A, type Credentials as C, type GetRestCallAuthParamsProps as G, type HostConfig as H, type RestCallAuthParams as R, type WebResourceAuthParams as W, type AuthModule as a, type GetWebSocketAuthParamsProps as b, type WebSocketAuthParams as c, type GetWebResourceAuthParamsProps as d, type GetRemoteAuthDataProps as e, type HandleAuthenticationErrorProps as f, type AuthenticationErrorAction as g, type HostConfigCommon as h, hostConfigCommonProperties as i, type AuthTypeThatCanBeOmitted as j, authTypesThatCanBeOmitted as k };
|
package/auth.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as AuthType, a as AuthModule, H as HostConfig } from './auth-types-
|
|
2
|
-
export { g as AuthenticationErrorAction, C as Credentials, e as GetRemoteAuthDataProps, G as GetRestCallAuthParamsProps,
|
|
1
|
+
import { A as AuthType, a as AuthModule, H as HostConfig, W as WebResourceAuthParams } from './auth-types-Cj5bM3Yk.js';
|
|
2
|
+
export { j as AuthTypeThatCanBeOmitted, g as AuthenticationErrorAction, C as Credentials, e as GetRemoteAuthDataProps, G as GetRestCallAuthParamsProps, d as GetWebResourceAuthParamsProps, b as GetWebSocketAuthParamsProps, f as HandleAuthenticationErrorProps, h as HostConfigCommon, R as RestCallAuthParams, c as WebSocketAuthParams, k as authTypesThatCanBeOmitted, i as hostConfigCommonProperties } from './auth-types-Cj5bM3Yk.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Registers an auth module that can handle authentication. An auth module is used by specifying its name as authType in the HostConfig passed in to api calls.
|
|
@@ -36,7 +36,14 @@ declare function getAccessToken({ hostConfig }: {
|
|
|
36
36
|
hostConfig?: HostConfig;
|
|
37
37
|
}): Promise<string>;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Returns a record of query parameters that needs to be added to resources requests, e.g.
|
|
40
|
+
* image tags, etc.
|
|
41
|
+
*/
|
|
42
|
+
declare function getWebResourceAuthParams({ hostConfig, }: {
|
|
43
|
+
hostConfig?: HostConfig;
|
|
44
|
+
}): Promise<WebResourceAuthParams>;
|
|
45
|
+
/**
|
|
46
|
+
* The AuthAPI interface provides the public interface for the auth module.
|
|
40
47
|
*/
|
|
41
48
|
interface AuthAPI {
|
|
42
49
|
/**
|
|
@@ -65,6 +72,11 @@ interface AuthAPI {
|
|
|
65
72
|
* Returns an access token using the supplied host config. Typically used on the backend to supply the access token to the frontend
|
|
66
73
|
*/
|
|
67
74
|
getAccessToken: typeof getAccessToken;
|
|
75
|
+
/**
|
|
76
|
+
* Returns a record of query parameters that needs to be added to resources requests, e.g.
|
|
77
|
+
* image tags, etc.
|
|
78
|
+
*/
|
|
79
|
+
getWebResourceAuthParams: typeof getWebResourceAuthParams;
|
|
68
80
|
}
|
|
69
81
|
declare const _default: {
|
|
70
82
|
registerAuthModule: typeof registerAuthModule;
|
|
@@ -72,6 +84,7 @@ declare const _default: {
|
|
|
72
84
|
registerHostConfig: typeof registerHostConfig;
|
|
73
85
|
unregisterHostConfig: typeof unregisterHostConfig;
|
|
74
86
|
getAccessToken: typeof getAccessToken;
|
|
87
|
+
getWebResourceAuthParams: typeof getWebResourceAuthParams;
|
|
75
88
|
};
|
|
76
89
|
|
|
77
|
-
export { type AuthAPI, AuthModule, AuthType, HostConfig, _default as default, getAccessToken, logout, registerAuthModule, registerHostConfig, setDefaultHostConfig, unregisterHostConfig };
|
|
90
|
+
export { type AuthAPI, AuthModule, AuthType, HostConfig, WebResourceAuthParams, _default as default, getAccessToken, getWebResourceAuthParams, logout, registerAuthModule, registerHostConfig, setDefaultHostConfig, unregisterHostConfig };
|
package/auth.js
CHANGED
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
import {
|
|
2
2
|
auth_default,
|
|
3
3
|
getAccessToken,
|
|
4
|
+
getWebResourceAuthParams,
|
|
4
5
|
logout,
|
|
5
6
|
registerAuthModule,
|
|
6
7
|
registerHostConfig,
|
|
7
8
|
setDefaultHostConfig,
|
|
8
9
|
unregisterHostConfig
|
|
9
|
-
} from "./chunks/
|
|
10
|
-
import "./chunks/
|
|
10
|
+
} from "./chunks/SPATCXXU.js";
|
|
11
|
+
import "./chunks/GPRUNZV4.js";
|
|
11
12
|
export {
|
|
12
13
|
auth_default as default,
|
|
13
14
|
getAccessToken,
|
|
15
|
+
getWebResourceAuthParams,
|
|
14
16
|
logout,
|
|
15
17
|
registerAuthModule,
|
|
16
18
|
registerHostConfig,
|
|
@@ -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 AutomationConnectionChangeOwnerObject = {
|
|
5
5
|
/** The unique identifier of the new owner. */
|
|
@@ -140,7 +140,7 @@ type PaginationLink = {
|
|
|
140
140
|
* @param query an object with query parameters
|
|
141
141
|
* @throws GetAutomationConnectionsHttpError
|
|
142
142
|
*/
|
|
143
|
-
declare
|
|
143
|
+
declare function getAutomationConnections(query: {
|
|
144
144
|
/** Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId. */
|
|
145
145
|
filter?: string;
|
|
146
146
|
/** The number of automation connections to retrieve. */
|
|
@@ -149,7 +149,7 @@ declare const getAutomationConnections: (query: {
|
|
|
149
149
|
listAll?: boolean;
|
|
150
150
|
/** The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order) */
|
|
151
151
|
sort?: "id" | "name" | "createdAt" | "updatedAt" | "+id" | "+name" | "+createdAt" | "+updatedAt" | "-id" | "-name" | "-createdAt" | "-updatedAt";
|
|
152
|
-
}, options?: ApiCallOptions)
|
|
152
|
+
}, options?: ApiCallOptions): Promise<GetAutomationConnectionsHttpResponse>;
|
|
153
153
|
type GetAutomationConnectionsHttpResponse = {
|
|
154
154
|
data: AutomationConnectionsList;
|
|
155
155
|
headers: Headers;
|
|
@@ -168,7 +168,7 @@ type GetAutomationConnectionsHttpError = {
|
|
|
168
168
|
* @param body an object with the body content
|
|
169
169
|
* @throws CreateAutomationConnectionHttpError
|
|
170
170
|
*/
|
|
171
|
-
declare
|
|
171
|
+
declare function createAutomationConnection(body: AutomationConnectionCreationObject, options?: ApiCallOptions): Promise<CreateAutomationConnectionHttpResponse>;
|
|
172
172
|
type CreateAutomationConnectionHttpResponse = {
|
|
173
173
|
data: AutomationConnectionDetailObject;
|
|
174
174
|
headers: Headers;
|
|
@@ -186,10 +186,10 @@ type CreateAutomationConnectionHttpError = {
|
|
|
186
186
|
* @param query an object with query parameters
|
|
187
187
|
* @throws DeleteAutomationConnectionHttpError
|
|
188
188
|
*/
|
|
189
|
-
declare
|
|
189
|
+
declare function deleteAutomationConnection(id: string, query: {
|
|
190
190
|
/** When true, the automation connection will be deleted regardless of its usage by any automations. */
|
|
191
191
|
forced?: boolean;
|
|
192
|
-
}, options?: ApiCallOptions)
|
|
192
|
+
}, options?: ApiCallOptions): Promise<DeleteAutomationConnectionHttpResponse>;
|
|
193
193
|
type DeleteAutomationConnectionHttpResponse = {
|
|
194
194
|
data: void;
|
|
195
195
|
headers: Headers;
|
|
@@ -206,7 +206,7 @@ type DeleteAutomationConnectionHttpError = {
|
|
|
206
206
|
* @param id The unique identifier for the automation connection.
|
|
207
207
|
* @throws GetAutomationConnectionHttpError
|
|
208
208
|
*/
|
|
209
|
-
declare
|
|
209
|
+
declare function getAutomationConnection(id: string, options?: ApiCallOptions): Promise<GetAutomationConnectionHttpResponse>;
|
|
210
210
|
type GetAutomationConnectionHttpResponse = {
|
|
211
211
|
data: AutomationConnectionDetailObject;
|
|
212
212
|
headers: Headers;
|
|
@@ -224,7 +224,7 @@ type GetAutomationConnectionHttpError = {
|
|
|
224
224
|
* @param body an object with the body content
|
|
225
225
|
* @throws UpdateAutomationConnectionHttpError
|
|
226
226
|
*/
|
|
227
|
-
declare
|
|
227
|
+
declare function updateAutomationConnection(id: string, body: AutomationConnectionPutRequestObject, options?: ApiCallOptions): Promise<UpdateAutomationConnectionHttpResponse>;
|
|
228
228
|
type UpdateAutomationConnectionHttpResponse = {
|
|
229
229
|
data: AutomationConnectionDetailObject;
|
|
230
230
|
headers: Headers;
|
|
@@ -242,7 +242,7 @@ type UpdateAutomationConnectionHttpError = {
|
|
|
242
242
|
* @param body an object with the body content
|
|
243
243
|
* @throws ChangeOwnerAutomationConnectionHttpError
|
|
244
244
|
*/
|
|
245
|
-
declare
|
|
245
|
+
declare function changeOwnerAutomationConnection(id: string, body: AutomationConnectionChangeOwnerObject, options?: ApiCallOptions): Promise<ChangeOwnerAutomationConnectionHttpResponse>;
|
|
246
246
|
type ChangeOwnerAutomationConnectionHttpResponse = {
|
|
247
247
|
data: void;
|
|
248
248
|
headers: Headers;
|
|
@@ -260,7 +260,7 @@ type ChangeOwnerAutomationConnectionHttpError = {
|
|
|
260
260
|
* @param body an object with the body content
|
|
261
261
|
* @throws ChangeSpaceAutomationConnectionHttpError
|
|
262
262
|
*/
|
|
263
|
-
declare
|
|
263
|
+
declare function changeSpaceAutomationConnection(id: string, body: AutomationConnectionChangeSpaceObject, options?: ApiCallOptions): Promise<ChangeSpaceAutomationConnectionHttpResponse>;
|
|
264
264
|
type ChangeSpaceAutomationConnectionHttpResponse = {
|
|
265
265
|
data: void;
|
|
266
266
|
headers: Headers;
|
|
@@ -277,7 +277,7 @@ type ChangeSpaceAutomationConnectionHttpError = {
|
|
|
277
277
|
* @param id The unique identifier for the automation connection.
|
|
278
278
|
* @throws CheckAutomationConnectionHttpError
|
|
279
279
|
*/
|
|
280
|
-
declare
|
|
280
|
+
declare function checkAutomationConnection(id: string, options?: ApiCallOptions): Promise<CheckAutomationConnectionHttpResponse>;
|
|
281
281
|
type CheckAutomationConnectionHttpResponse = {
|
|
282
282
|
data: AutomationConnectionCheckObject;
|
|
283
283
|
headers: Headers;
|
|
@@ -1,67 +1,83 @@
|
|
|
1
1
|
import {
|
|
2
2
|
clearApiCache,
|
|
3
3
|
invokeFetch
|
|
4
|
-
} from "./chunks/
|
|
5
|
-
import "./chunks/
|
|
6
|
-
import "./chunks/
|
|
4
|
+
} from "./chunks/LIEZG7IM.js";
|
|
5
|
+
import "./chunks/GPRUNZV4.js";
|
|
6
|
+
import "./chunks/7MMXU6EL.js";
|
|
7
7
|
|
|
8
8
|
// src/public/rest/automation-connections.ts
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
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
|
+
}
|
|
65
81
|
function clearCache() {
|
|
66
82
|
return clearApiCache("automation-connections");
|
|
67
83
|
}
|
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;
|