@qlik/api 0.0.2 → 0.0.3

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 (171) hide show
  1. package/api-keys.d.mts +14 -0
  2. package/api-keys.d.ts +14 -0
  3. package/api-keys.js +14 -10
  4. package/api-keys.mjs +6 -2
  5. package/apps.d.mts +478 -148
  6. package/apps.d.ts +478 -148
  7. package/apps.js +100 -42
  8. package/apps.mjs +60 -2
  9. package/audits.d.mts +12 -0
  10. package/audits.d.ts +12 -0
  11. package/audits.js +10 -9
  12. package/audits.mjs +3 -2
  13. package/auth-AWZV4DPP.js +41 -0
  14. package/{auth-RTFXVSSK.mjs → auth-CPBNNC7S.mjs} +4 -1
  15. package/auth.js +4 -3
  16. package/auth.mjs +3 -2
  17. package/automations.d.mts +36 -0
  18. package/automations.d.ts +36 -0
  19. package/automations.js +28 -21
  20. package/automations.mjs +9 -2
  21. package/brands.d.mts +45 -4
  22. package/brands.d.ts +45 -4
  23. package/brands.js +20 -15
  24. package/brands.mjs +7 -2
  25. package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
  26. package/{chunk-7REWEWCX.mjs → chunk-3SVRHJII.mjs} +3 -3
  27. package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
  28. package/{chunk-M7F4JFOB.js → chunk-7RY3NO6N.js} +2 -2
  29. package/{chunk-NALKLKZS.mjs → chunk-CYRLVHU3.mjs} +316 -53
  30. package/{chunk-RMKP2BDX.js → chunk-D52VW5UN.js} +318 -55
  31. package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
  32. package/{chunk-QN23TPIE.js → chunk-GV5SRHY2.js} +4 -4
  33. package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
  34. package/chunk-P57PW2II.js +11 -0
  35. package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
  36. package/chunk-ZFXKCRJC.mjs +11 -0
  37. package/collections.d.mts +51 -17
  38. package/collections.d.ts +51 -17
  39. package/collections.js +28 -14
  40. package/collections.mjs +16 -2
  41. package/csp-origins.d.mts +12 -0
  42. package/csp-origins.d.ts +12 -0
  43. package/csp-origins.js +12 -9
  44. package/csp-origins.mjs +5 -2
  45. package/data-assets.d.mts +10 -0
  46. package/data-assets.d.ts +10 -0
  47. package/data-assets.js +13 -8
  48. package/data-assets.mjs +7 -2
  49. package/data-connections.d.mts +18 -0
  50. package/data-connections.d.ts +18 -0
  51. package/data-connections.js +19 -12
  52. package/data-connections.mjs +9 -2
  53. package/data-credentials.d.mts +8 -0
  54. package/data-credentials.d.ts +8 -0
  55. package/data-credentials.js +10 -7
  56. package/data-credentials.mjs +5 -2
  57. package/data-files.d.mts +98 -13
  58. package/data-files.d.ts +98 -13
  59. package/data-files.js +22 -15
  60. package/data-files.mjs +9 -2
  61. package/{enigma-session-VPPJMBEM.js → enigma-session-XPXDQAIV.js} +5 -4
  62. package/{enigma-session-HGXKZJVO.mjs → enigma-session-ZH6MYA54.mjs} +2 -1
  63. package/{esm-RX7B2TUN.js → esm-3VXX2GKL.js} +3 -1
  64. package/{esm-M5ZBFTVD.mjs → esm-OY4XVIJB.mjs} +3 -1
  65. package/extensions.d.mts +26 -2
  66. package/extensions.d.ts +26 -2
  67. package/extensions.js +13 -10
  68. package/extensions.mjs +5 -2
  69. package/glossaries.d.mts +55 -20
  70. package/glossaries.d.ts +55 -20
  71. package/glossaries.js +39 -27
  72. package/glossaries.mjs +14 -2
  73. package/groups.d.mts +16 -0
  74. package/groups.d.ts +16 -0
  75. package/groups.js +16 -11
  76. package/groups.mjs +7 -2
  77. package/identity-providers.d.mts +16 -0
  78. package/identity-providers.d.ts +16 -0
  79. package/identity-providers.js +14 -11
  80. package/identity-providers.mjs +5 -2
  81. package/index.js +135 -101
  82. package/index.mjs +131 -97
  83. package/{invoke-fetch-IMO4AMA3.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
  84. package/invoke-fetch-UNTAUR7O.js +17 -0
  85. package/items.d.mts +6 -6
  86. package/items.d.ts +6 -6
  87. package/items.js +14 -11
  88. package/items.mjs +5 -2
  89. package/licenses.d.mts +18 -0
  90. package/licenses.d.ts +18 -0
  91. package/licenses.js +17 -12
  92. package/licenses.mjs +7 -2
  93. package/package.json +4 -4
  94. package/{qix-K22VHZRH.js → qix-UNWXPGMA.js} +9 -8
  95. package/{qix-57WD2ZE6.mjs → qix-ZSJ4PIK3.mjs} +3 -2
  96. package/qix.d.mts +1 -1
  97. package/qix.d.ts +1 -1
  98. package/qix.js +4 -3
  99. package/qix.mjs +3 -2
  100. package/quotas.d.mts +4 -0
  101. package/quotas.d.ts +4 -0
  102. package/quotas.js +6 -5
  103. package/quotas.mjs +3 -2
  104. package/reload-tasks.js +11 -8
  105. package/reload-tasks.mjs +5 -2
  106. package/reloads.d.mts +17 -10
  107. package/reloads.d.ts +17 -10
  108. package/reloads.js +9 -7
  109. package/reloads.mjs +4 -2
  110. package/roles.d.mts +4 -0
  111. package/roles.d.ts +4 -0
  112. package/roles.js +6 -5
  113. package/roles.mjs +3 -2
  114. package/spaces.d.mts +27 -4
  115. package/spaces.d.ts +27 -4
  116. package/spaces.js +21 -15
  117. package/spaces.mjs +8 -2
  118. package/temp-contents.d.mts +8 -3
  119. package/temp-contents.d.ts +8 -3
  120. package/temp-contents.js +8 -6
  121. package/temp-contents.mjs +4 -2
  122. package/tenants.d.mts +12 -0
  123. package/tenants.d.ts +12 -0
  124. package/tenants.js +14 -9
  125. package/tenants.mjs +7 -2
  126. package/themes.d.mts +26 -2
  127. package/themes.d.ts +26 -2
  128. package/themes.js +13 -10
  129. package/themes.mjs +5 -2
  130. package/transports.d.mts +12 -0
  131. package/transports.d.ts +12 -0
  132. package/transports.js +12 -9
  133. package/transports.mjs +5 -2
  134. package/users.d.mts +48 -29
  135. package/users.d.ts +48 -29
  136. package/users.js +18 -13
  137. package/users.mjs +7 -2
  138. package/web-integrations.d.mts +10 -0
  139. package/web-integrations.d.ts +10 -0
  140. package/web-integrations.js +11 -8
  141. package/web-integrations.mjs +5 -2
  142. package/web-notifications.d.mts +12 -0
  143. package/web-notifications.d.ts +12 -0
  144. package/web-notifications.js +12 -9
  145. package/web-notifications.mjs +5 -2
  146. package/webhooks.d.mts +25 -5
  147. package/webhooks.d.ts +25 -5
  148. package/webhooks.js +17 -13
  149. package/webhooks.mjs +6 -2
  150. package/auth-CSVTXOZX.js +0 -36
  151. package/auth-OU7OTB7Y.js +0 -38
  152. package/auth-TE272Q34.mjs +0 -36
  153. package/chunk-4ES65KO3.js +0 -57
  154. package/chunk-4FLMND6T.js +0 -25
  155. package/chunk-4OMEH5SW.mjs +0 -1337
  156. package/chunk-6JERR27K.js +0 -17
  157. package/chunk-E42WUFCK.mjs +0 -57
  158. package/chunk-H7SAZYEE.js +0 -21
  159. package/chunk-KMMWJZHM.mjs +0 -25
  160. package/chunk-W4J34XGA.mjs +0 -17
  161. package/chunk-WM7FQU2U.mjs +0 -21
  162. package/chunk-XASXL2NC.js +0 -1337
  163. package/enigma-session-4L373ALV.mjs +0 -10196
  164. package/enigma-session-TEB53FAF.js +0 -10196
  165. package/esm-4X3DKK5D.js +0 -63
  166. package/esm-SOWVJKOQ.mjs +0 -63
  167. package/invoke-fetch-7PKPQ3FD.js +0 -14
  168. package/invoke-fetch-MSSJAZ7K.mjs +0 -14
  169. package/invoke-fetch-PEI54KZO.js +0 -14
  170. package/qix-EU7PXRZ6.mjs +0 -573
  171. package/qix-RLTISYTB.js +0 -573
package/audits.d.ts CHANGED
@@ -92,6 +92,7 @@ type ListLinks = {
92
92
  };
93
93
  /**
94
94
  * Finds and returns the persisted audit events for the given tenant.
95
+ *
95
96
  * @param query an object with query parameters
96
97
  * @throws GetAuditsHttpError
97
98
  */
@@ -129,6 +130,7 @@ type GetAuditsHttpError = {
129
130
  };
130
131
  /**
131
132
  * Finds and returns audit events from the archive, formatted as a JSON array, for the given date and tenant (in JWT).
133
+ *
132
134
  * @param query an object with query parameters
133
135
  * @throws GetArchivedAuditsHttpError
134
136
  */
@@ -148,6 +150,7 @@ type GetArchivedAuditsHttpError = {
148
150
  };
149
151
  /**
150
152
  * It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.
153
+ *
151
154
  * @throws GetAuditsSettingsHttpError
152
155
  */
153
156
  declare const getAuditsSettings: (options?: ApiCallOptions) => Promise<GetAuditsSettingsHttpResponse>;
@@ -163,6 +166,7 @@ type GetAuditsSettingsHttpError = {
163
166
  };
164
167
  /**
165
168
  * Finds and returns the distinct list of unique event sources.
169
+ *
166
170
  * @throws GetAuditSourcesHttpError
167
171
  */
168
172
  declare const getAuditSources: (options?: ApiCallOptions) => Promise<GetAuditSourcesHttpResponse>;
@@ -180,6 +184,7 @@ type GetAuditSourcesHttpError = {
180
184
  };
181
185
  /**
182
186
  * Finds and returns the distinct list of unique event types.
187
+ *
183
188
  * @throws GetAuditTypesHttpError
184
189
  */
185
190
  declare const getAuditTypes: (options?: ApiCallOptions) => Promise<GetAuditTypesHttpResponse>;
@@ -197,6 +202,7 @@ type GetAuditTypesHttpError = {
197
202
  };
198
203
  /**
199
204
  * Finds and returns the persisted audit events for the given tenant.
205
+ *
200
206
  * @param id The audit item's unique identifier.
201
207
  * @throws GetAuditHttpError
202
208
  */
@@ -218,33 +224,39 @@ declare function clearCache(): void;
218
224
  interface AuditsAPI {
219
225
  /**
220
226
  * Finds and returns the persisted audit events for the given tenant.
227
+ *
221
228
  * @param query an object with query parameters
222
229
  * @throws GetAuditsHttpError
223
230
  */
224
231
  getAudits: typeof getAudits;
225
232
  /**
226
233
  * Finds and returns audit events from the archive, formatted as a JSON array, for the given date and tenant (in JWT).
234
+ *
227
235
  * @param query an object with query parameters
228
236
  * @throws GetArchivedAuditsHttpError
229
237
  */
230
238
  getArchivedAudits: typeof getArchivedAudits;
231
239
  /**
232
240
  * It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.
241
+ *
233
242
  * @throws GetAuditsSettingsHttpError
234
243
  */
235
244
  getAuditsSettings: typeof getAuditsSettings;
236
245
  /**
237
246
  * Finds and returns the distinct list of unique event sources.
247
+ *
238
248
  * @throws GetAuditSourcesHttpError
239
249
  */
240
250
  getAuditSources: typeof getAuditSources;
241
251
  /**
242
252
  * Finds and returns the distinct list of unique event types.
253
+ *
243
254
  * @throws GetAuditTypesHttpError
244
255
  */
245
256
  getAuditTypes: typeof getAuditTypes;
246
257
  /**
247
258
  * Finds and returns the persisted audit events for the given tenant.
259
+ *
248
260
  * @param id The audit item's unique identifier.
249
261
  * @throws GetAuditHttpError
250
262
  */
package/audits.js CHANGED
@@ -1,45 +1,46 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunk6JERR27Kjs = require('./chunk-6JERR27K.js');
5
- require('./chunk-H7SAZYEE.js');
4
+ var _chunkJNGURO23js = require('./chunk-JNGURO23.js');
5
+ require('./chunk-2STFUQKQ.js');
6
+ require('./chunk-P57PW2II.js');
6
7
 
7
8
  // src/public/rest/audits.ts
8
- var getAudits = async (query, options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "audits", {
9
+ var getAudits = async (query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "audits", {
9
10
  method: "get",
10
11
  pathTemplate: "/api/v1/audits",
11
12
  query,
12
13
  options
13
14
  });
14
- var getArchivedAudits = async (query, options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "audits", {
15
+ var getArchivedAudits = async (query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "audits", {
15
16
  method: "get",
16
17
  pathTemplate: "/api/v1/audits/archive",
17
18
  query,
18
19
  options
19
20
  });
20
- var getAuditsSettings = async (options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "audits", {
21
+ var getAuditsSettings = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "audits", {
21
22
  method: "get",
22
23
  pathTemplate: "/api/v1/audits/settings",
23
24
  options
24
25
  });
25
- var getAuditSources = async (options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "audits", {
26
+ var getAuditSources = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "audits", {
26
27
  method: "get",
27
28
  pathTemplate: "/api/v1/audits/sources",
28
29
  options
29
30
  });
30
- var getAuditTypes = async (options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "audits", {
31
+ var getAuditTypes = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "audits", {
31
32
  method: "get",
32
33
  pathTemplate: "/api/v1/audits/types",
33
34
  options
34
35
  });
35
- var getAudit = async (id, options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "audits", {
36
+ var getAudit = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "audits", {
36
37
  method: "get",
37
38
  pathTemplate: "/api/v1/audits/{id}",
38
39
  pathVariables: { id },
39
40
  options
40
41
  });
41
42
  function clearCache() {
42
- return _chunk6JERR27Kjs.clearApiCache.call(void 0, "audits");
43
+ return _chunkJNGURO23js.clearApiCache.call(void 0, "audits");
43
44
  }
44
45
  var auditsExport = {
45
46
  getAudits,
package/audits.mjs CHANGED
@@ -1,8 +1,9 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-W4J34XGA.mjs";
5
- import "./chunk-7REWEWCX.mjs";
4
+ } from "./chunk-TE7XMBT5.mjs";
5
+ import "./chunk-3SVRHJII.mjs";
6
+ import "./chunk-ZFXKCRJC.mjs";
6
7
 
7
8
  // src/public/rest/audits.ts
8
9
  var getAudits = async (query, options) => invokeFetch("audits", {
@@ -0,0 +1,41 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
+
3
+
4
+
5
+
6
+
7
+
8
+
9
+
10
+
11
+
12
+
13
+
14
+
15
+
16
+
17
+
18
+
19
+
20
+ var _chunkD52VW5UNjs = require('./chunk-D52VW5UN.js');
21
+ require('./chunk-P57PW2II.js');
22
+
23
+
24
+
25
+
26
+
27
+
28
+
29
+
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+
41
+ exports.AuthorizationError = _chunkD52VW5UNjs.AuthorizationError; exports.InvalidAuthTypeError = _chunkD52VW5UNjs.InvalidAuthTypeError; exports.InvalidHostConfigError = _chunkD52VW5UNjs.InvalidHostConfigError; exports.UnexpectedAuthTypeError = _chunkD52VW5UNjs.UnexpectedAuthTypeError; exports.checkForCrossDomainRequest = _chunkD52VW5UNjs.checkForCrossDomainRequest; exports.default = _chunkD52VW5UNjs.auth_default; exports.getRestCallAuthParams = _chunkD52VW5UNjs.getRestCallAuthParams; exports.getWebResourceAuthParams = _chunkD52VW5UNjs.getWebResourceAuthParams; exports.getWebSocketAuthParams = _chunkD52VW5UNjs.getWebSocketAuthParams; exports.handleAuthenticationError = _chunkD52VW5UNjs.handleAuthenticationError; exports.isHostCrossOrigin = _chunkD52VW5UNjs.isHostCrossOrigin; exports.isWindows = _chunkD52VW5UNjs.isWindows; exports.logout = _chunkD52VW5UNjs.logout; exports.registerAuthModule = _chunkD52VW5UNjs.registerAuthModule; exports.setDefaultHostConfig = _chunkD52VW5UNjs.setDefaultHostConfig; exports.toValidEnigmaLocationUrl = _chunkD52VW5UNjs.toValidEnigmaLocationUrl; exports.toValidLocationUrl = _chunkD52VW5UNjs.toValidLocationUrl; exports.toValidWebsocketLocationUrl = _chunkD52VW5UNjs.toValidWebsocketLocationUrl;
@@ -1,4 +1,5 @@
1
1
  import {
2
+ AuthorizationError,
2
3
  InvalidAuthTypeError,
3
4
  InvalidHostConfigError,
4
5
  UnexpectedAuthTypeError,
@@ -16,8 +17,10 @@ import {
16
17
  toValidEnigmaLocationUrl,
17
18
  toValidLocationUrl,
18
19
  toValidWebsocketLocationUrl
19
- } from "./chunk-NALKLKZS.mjs";
20
+ } from "./chunk-CYRLVHU3.mjs";
21
+ import "./chunk-ZFXKCRJC.mjs";
20
22
  export {
23
+ AuthorizationError,
21
24
  InvalidAuthTypeError,
22
25
  InvalidHostConfigError,
23
26
  UnexpectedAuthTypeError,
package/auth.js CHANGED
@@ -3,11 +3,12 @@
3
3
 
4
4
 
5
5
 
6
- var _chunkQN23TPIEjs = require('./chunk-QN23TPIE.js');
7
- require('./chunk-H7SAZYEE.js');
6
+ var _chunkGV5SRHY2js = require('./chunk-GV5SRHY2.js');
7
+ require('./chunk-2STFUQKQ.js');
8
+ require('./chunk-P57PW2II.js');
8
9
 
9
10
 
10
11
 
11
12
 
12
13
 
13
- exports.default = _chunkQN23TPIEjs.auth_default; exports.logout = _chunkQN23TPIEjs.logout; exports.registerAuthModule = _chunkQN23TPIEjs.registerAuthModule; exports.setDefaultHostConfig = _chunkQN23TPIEjs.setDefaultHostConfig;
14
+ exports.default = _chunkGV5SRHY2js.auth_default; exports.logout = _chunkGV5SRHY2js.logout; exports.registerAuthModule = _chunkGV5SRHY2js.registerAuthModule; exports.setDefaultHostConfig = _chunkGV5SRHY2js.setDefaultHostConfig;
package/auth.mjs CHANGED
@@ -3,8 +3,9 @@ import {
3
3
  logout,
4
4
  registerAuthModule,
5
5
  setDefaultHostConfig
6
- } from "./chunk-KMMWJZHM.mjs";
7
- import "./chunk-7REWEWCX.mjs";
6
+ } from "./chunk-GNWU6SP2.mjs";
7
+ import "./chunk-3SVRHJII.mjs";
8
+ import "./chunk-ZFXKCRJC.mjs";
8
9
  export {
9
10
  auth_default as default,
10
11
  logout,
package/automations.d.mts CHANGED
@@ -175,6 +175,7 @@ type UsageObject = {
175
175
  };
176
176
  /**
177
177
  * Retrieves a list of automations
178
+ *
178
179
  * @param query an object with query parameters
179
180
  * @throws GetAutomationsHttpError
180
181
  */
@@ -200,6 +201,7 @@ type GetAutomationsHttpError = {
200
201
  };
201
202
  /**
202
203
  * Create an automation
204
+ *
203
205
  * @param body an object with the body content
204
206
  * @throws CreateAutomationHttpError
205
207
  */
@@ -216,6 +218,7 @@ type CreateAutomationHttpError = {
216
218
  };
217
219
  /**
218
220
  * Retrieves the automation settings.
221
+ *
219
222
  * @throws GetAutomationsSettingsHttpError
220
223
  */
221
224
  declare const getAutomationsSettings: (options?: ApiCallOptions) => Promise<GetAutomationsSettingsHttpResponse>;
@@ -231,6 +234,7 @@ type GetAutomationsSettingsHttpError = {
231
234
  };
232
235
  /**
233
236
  * Update the automation settings.
237
+ *
234
238
  * @param body an object with the body content
235
239
  * @throws UpdateAutomationsSettingsHttpError
236
240
  */
@@ -248,6 +252,7 @@ type UpdateAutomationsSettingsHttpError = {
248
252
  /**
249
253
  * **Limitations:**
250
254
  * * **Maximum 1000 metrics per API call**
255
+ *
251
256
  * @param query an object with query parameters
252
257
  * @throws GetAutomationsUsageMetricsHttpError
253
258
  */
@@ -269,6 +274,7 @@ type GetAutomationsUsageMetricsHttpError = {
269
274
  };
270
275
  /**
271
276
  * Delete an automation
277
+ *
272
278
  * @param id The unique identifier for the automation.
273
279
  * @throws DeleteAutomationHttpError
274
280
  */
@@ -285,6 +291,7 @@ type DeleteAutomationHttpError = {
285
291
  };
286
292
  /**
287
293
  * Retrieves an automation
294
+ *
288
295
  * @param id The unique identifier for the automation.
289
296
  * @throws GetAutomationHttpError
290
297
  */
@@ -301,6 +308,7 @@ type GetAutomationHttpError = {
301
308
  };
302
309
  /**
303
310
  * Update an automation
311
+ *
304
312
  * @param id The unique identifier for the automation.
305
313
  * @param body an object with the body content
306
314
  * @throws UpdateAutomationHttpError
@@ -318,6 +326,7 @@ type UpdateAutomationHttpError = {
318
326
  };
319
327
  /**
320
328
  * Copy an automation.
329
+ *
321
330
  * @param id The unique identifier for the automation.
322
331
  * @param body an object with the body content
323
332
  * @throws CopyAutomationHttpError
@@ -341,6 +350,7 @@ type CopyAutomationHttpError = {
341
350
  };
342
351
  /**
343
352
  * Disables an automation.
353
+ *
344
354
  * @param id The unique identifier for the automation.
345
355
  * @throws DisableAutomationHttpError
346
356
  */
@@ -357,6 +367,7 @@ type DisableAutomationHttpError = {
357
367
  };
358
368
  /**
359
369
  * Enable an automation.
370
+ *
360
371
  * @param id The unique identifier for the automation.
361
372
  * @throws EnableAutomationHttpError
362
373
  */
@@ -373,6 +384,7 @@ type EnableAutomationHttpError = {
373
384
  };
374
385
  /**
375
386
  * This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.
387
+ *
376
388
  * @param id The unique identifier for the automation.
377
389
  * @param body an object with the body content
378
390
  * @throws MoveAutomationHttpError
@@ -392,6 +404,7 @@ type MoveAutomationHttpError = {
392
404
  };
393
405
  /**
394
406
  * Retrieves a list of runs for a specific automation.
407
+ *
395
408
  * @param id The unique identifier for the automation.
396
409
  * @param query an object with query parameters
397
410
  * @throws GetAutomationRunsHttpError
@@ -418,6 +431,7 @@ type GetAutomationRunsHttpError = {
418
431
  };
419
432
  /**
420
433
  * Create a run
434
+ *
421
435
  * @param id The unique identifier for the automation.
422
436
  * @param body an object with the body content
423
437
  * @throws QueueAutomationRunHttpError
@@ -435,6 +449,7 @@ type QueueAutomationRunHttpError = {
435
449
  };
436
450
  /**
437
451
  * Retrieves a run
452
+ *
438
453
  * @param id The unique identifier for the automation.
439
454
  * @param runId The unique identifier for the run.
440
455
  * @throws GetAutomationRunHttpError
@@ -452,6 +467,7 @@ type GetAutomationRunHttpError = {
452
467
  };
453
468
  /**
454
469
  * Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.
470
+ *
455
471
  * @param id The unique identifier for the automation.
456
472
  * @param runId The unique identifier for the run.
457
473
  * @throws GetAutomationRunDetailsHttpError
@@ -471,6 +487,7 @@ type GetAutomationRunDetailsHttpError = {
471
487
  };
472
488
  /**
473
489
  * This action allows you to retry a specific run by creating a new run using the same inputs.
490
+ *
474
491
  * @param id The unique identifier for the automation.
475
492
  * @param runId The unique identifier for the run.
476
493
  * @throws RetryAutomationRunHttpError
@@ -488,6 +505,7 @@ type RetryAutomationRunHttpError = {
488
505
  };
489
506
  /**
490
507
  * Force a run to be stopped immediately.
508
+ *
491
509
  * @param id The unique identifier for the automation.
492
510
  * @param runId The unique identifier for the run.
493
511
  * @throws StopAutomationRunHttpError
@@ -510,23 +528,27 @@ declare function clearCache(): void;
510
528
  interface AutomationsAPI {
511
529
  /**
512
530
  * Retrieves a list of automations
531
+ *
513
532
  * @param query an object with query parameters
514
533
  * @throws GetAutomationsHttpError
515
534
  */
516
535
  getAutomations: typeof getAutomations;
517
536
  /**
518
537
  * Create an automation
538
+ *
519
539
  * @param body an object with the body content
520
540
  * @throws CreateAutomationHttpError
521
541
  */
522
542
  createAutomation: typeof createAutomation;
523
543
  /**
524
544
  * Retrieves the automation settings.
545
+ *
525
546
  * @throws GetAutomationsSettingsHttpError
526
547
  */
527
548
  getAutomationsSettings: typeof getAutomationsSettings;
528
549
  /**
529
550
  * Update the automation settings.
551
+ *
530
552
  * @param body an object with the body content
531
553
  * @throws UpdateAutomationsSettingsHttpError
532
554
  */
@@ -534,24 +556,28 @@ interface AutomationsAPI {
534
556
  /**
535
557
  * **Limitations:**
536
558
  * * **Maximum 1000 metrics per API call**
559
+ *
537
560
  * @param query an object with query parameters
538
561
  * @throws GetAutomationsUsageMetricsHttpError
539
562
  */
540
563
  getAutomationsUsageMetrics: typeof getAutomationsUsageMetrics;
541
564
  /**
542
565
  * Delete an automation
566
+ *
543
567
  * @param id The unique identifier for the automation.
544
568
  * @throws DeleteAutomationHttpError
545
569
  */
546
570
  deleteAutomation: typeof deleteAutomation;
547
571
  /**
548
572
  * Retrieves an automation
573
+ *
549
574
  * @param id The unique identifier for the automation.
550
575
  * @throws GetAutomationHttpError
551
576
  */
552
577
  getAutomation: typeof getAutomation;
553
578
  /**
554
579
  * Update an automation
580
+ *
555
581
  * @param id The unique identifier for the automation.
556
582
  * @param body an object with the body content
557
583
  * @throws UpdateAutomationHttpError
@@ -559,6 +585,7 @@ interface AutomationsAPI {
559
585
  updateAutomation: typeof updateAutomation;
560
586
  /**
561
587
  * Copy an automation.
588
+ *
562
589
  * @param id The unique identifier for the automation.
563
590
  * @param body an object with the body content
564
591
  * @throws CopyAutomationHttpError
@@ -566,18 +593,21 @@ interface AutomationsAPI {
566
593
  copyAutomation: typeof copyAutomation;
567
594
  /**
568
595
  * Disables an automation.
596
+ *
569
597
  * @param id The unique identifier for the automation.
570
598
  * @throws DisableAutomationHttpError
571
599
  */
572
600
  disableAutomation: typeof disableAutomation;
573
601
  /**
574
602
  * Enable an automation.
603
+ *
575
604
  * @param id The unique identifier for the automation.
576
605
  * @throws EnableAutomationHttpError
577
606
  */
578
607
  enableAutomation: typeof enableAutomation;
579
608
  /**
580
609
  * This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.
610
+ *
581
611
  * @param id The unique identifier for the automation.
582
612
  * @param body an object with the body content
583
613
  * @throws MoveAutomationHttpError
@@ -585,6 +615,7 @@ interface AutomationsAPI {
585
615
  moveAutomation: typeof moveAutomation;
586
616
  /**
587
617
  * Retrieves a list of runs for a specific automation.
618
+ *
588
619
  * @param id The unique identifier for the automation.
589
620
  * @param query an object with query parameters
590
621
  * @throws GetAutomationRunsHttpError
@@ -592,6 +623,7 @@ interface AutomationsAPI {
592
623
  getAutomationRuns: typeof getAutomationRuns;
593
624
  /**
594
625
  * Create a run
626
+ *
595
627
  * @param id The unique identifier for the automation.
596
628
  * @param body an object with the body content
597
629
  * @throws QueueAutomationRunHttpError
@@ -599,6 +631,7 @@ interface AutomationsAPI {
599
631
  queueAutomationRun: typeof queueAutomationRun;
600
632
  /**
601
633
  * Retrieves a run
634
+ *
602
635
  * @param id The unique identifier for the automation.
603
636
  * @param runId The unique identifier for the run.
604
637
  * @throws GetAutomationRunHttpError
@@ -606,6 +639,7 @@ interface AutomationsAPI {
606
639
  getAutomationRun: typeof getAutomationRun;
607
640
  /**
608
641
  * Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.
642
+ *
609
643
  * @param id The unique identifier for the automation.
610
644
  * @param runId The unique identifier for the run.
611
645
  * @throws GetAutomationRunDetailsHttpError
@@ -613,6 +647,7 @@ interface AutomationsAPI {
613
647
  getAutomationRunDetails: typeof getAutomationRunDetails;
614
648
  /**
615
649
  * This action allows you to retry a specific run by creating a new run using the same inputs.
650
+ *
616
651
  * @param id The unique identifier for the automation.
617
652
  * @param runId The unique identifier for the run.
618
653
  * @throws RetryAutomationRunHttpError
@@ -620,6 +655,7 @@ interface AutomationsAPI {
620
655
  retryAutomationRun: typeof retryAutomationRun;
621
656
  /**
622
657
  * Force a run to be stopped immediately.
658
+ *
623
659
  * @param id The unique identifier for the automation.
624
660
  * @param runId The unique identifier for the run.
625
661
  * @throws StopAutomationRunHttpError