@qlik/api 0.0.1 → 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.
- package/.github/CODEOWNERS +2 -0
- package/.github/workflows/release.yaml +35 -0
- package/README.md +1 -3
- package/api-keys.d.mts +27 -13
- package/api-keys.d.ts +27 -13
- package/api-keys.js +17 -13
- package/api-keys.mjs +12 -8
- package/apps.d.mts +580 -165
- package/apps.d.ts +580 -165
- package/apps.js +111 -44
- package/apps.mjs +78 -11
- package/audits.d.mts +20 -8
- package/audits.d.ts +20 -8
- package/audits.js +12 -11
- package/audits.mjs +7 -6
- package/auth-AWZV4DPP.js +41 -0
- package/{auth-TE272Q34.mjs → auth-CPBNNC7S.mjs} +8 -3
- package/auth.js +4 -3
- package/auth.mjs +3 -2
- package/automations.d.mts +56 -20
- package/automations.d.ts +56 -20
- package/automations.js +32 -25
- package/automations.mjs +18 -11
- package/brands.d.mts +45 -4
- package/brands.d.ts +45 -4
- package/brands.js +20 -15
- package/brands.mjs +7 -2
- package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
- package/{chunk-WM7FQU2U.mjs → chunk-3SVRHJII.mjs} +3 -3
- package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
- package/{chunk-4ES65KO3.js → chunk-7RY3NO6N.js} +2 -2
- package/{chunk-4OMEH5SW.mjs → chunk-CYRLVHU3.mjs} +321 -53
- package/{chunk-XASXL2NC.js → chunk-D52VW5UN.js} +323 -55
- package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
- package/{chunk-4FLMND6T.js → chunk-GV5SRHY2.js} +4 -4
- package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
- package/chunk-P57PW2II.js +11 -0
- package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
- package/chunk-ZFXKCRJC.mjs +11 -0
- package/collections.d.mts +52 -18
- package/collections.d.ts +52 -18
- package/collections.js +28 -14
- package/collections.mjs +16 -2
- package/csp-origins.d.mts +12 -0
- package/csp-origins.d.ts +12 -0
- package/csp-origins.js +12 -9
- package/csp-origins.mjs +5 -2
- package/data-assets.d.mts +10 -0
- package/data-assets.d.ts +10 -0
- package/data-assets.js +13 -8
- package/data-assets.mjs +7 -2
- package/data-connections.d.mts +20 -0
- package/data-connections.d.ts +20 -0
- package/data-connections.js +19 -12
- package/data-connections.mjs +9 -2
- package/data-credentials.d.mts +10 -0
- package/data-credentials.d.ts +10 -0
- package/data-credentials.js +10 -7
- package/data-credentials.mjs +5 -2
- package/data-files.d.mts +114 -29
- package/data-files.d.ts +114 -29
- package/data-files.js +25 -18
- package/data-files.mjs +15 -8
- package/{enigma-session-TEB53FAF.js → enigma-session-XPXDQAIV.js} +12 -7
- package/{enigma-session-4L373ALV.mjs → enigma-session-ZH6MYA54.mjs} +10 -5
- package/{esm-4X3DKK5D.js → esm-3VXX2GKL.js} +13 -9
- package/{esm-SOWVJKOQ.mjs → esm-OY4XVIJB.mjs} +13 -9
- package/extensions.d.mts +26 -2
- package/extensions.d.ts +26 -2
- package/extensions.js +13 -10
- package/extensions.mjs +5 -2
- package/glossaries.d.mts +55 -20
- package/glossaries.d.ts +55 -20
- package/glossaries.js +39 -27
- package/glossaries.mjs +14 -2
- package/groups.d.mts +29 -13
- package/groups.d.ts +29 -13
- package/groups.js +19 -14
- package/groups.mjs +13 -8
- package/identity-providers.d.mts +23 -7
- package/identity-providers.d.ts +23 -7
- package/identity-providers.js +16 -13
- package/identity-providers.mjs +8 -5
- package/index.js +150 -112
- package/index.mjs +146 -108
- package/{invoke-fetch-MSSJAZ7K.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
- package/invoke-fetch-UNTAUR7O.js +17 -0
- package/items.d.mts +25 -22
- package/items.d.ts +25 -22
- package/items.js +17 -14
- package/items.mjs +11 -8
- package/licenses.d.mts +20 -0
- package/licenses.d.ts +20 -0
- package/licenses.js +17 -12
- package/licenses.mjs +7 -2
- package/package.json +7 -18
- package/{qix-RLTISYTB.js → qix-UNWXPGMA.js} +9 -8
- package/{qix-EU7PXRZ6.mjs → qix-ZSJ4PIK3.mjs} +5 -4
- package/qix.d.mts +1066 -1017
- package/qix.d.ts +1066 -1017
- package/qix.js +4 -3
- package/qix.mjs +3 -2
- package/quotas.d.mts +4 -0
- package/quotas.d.ts +4 -0
- package/quotas.js +6 -5
- package/quotas.mjs +3 -2
- package/reload-tasks.d.mts +2 -0
- package/reload-tasks.d.ts +2 -0
- package/reload-tasks.js +11 -8
- package/reload-tasks.mjs +5 -2
- package/reloads.d.mts +20 -11
- package/reloads.d.ts +20 -11
- package/reloads.js +9 -7
- package/reloads.mjs +4 -2
- package/roles.d.mts +4 -0
- package/roles.d.ts +4 -0
- package/roles.js +6 -5
- package/roles.mjs +3 -2
- package/spaces.d.mts +36 -30
- package/spaces.d.ts +36 -30
- package/spaces.js +21 -15
- package/spaces.mjs +8 -2
- package/temp-contents.d.mts +9 -70
- package/temp-contents.d.ts +9 -70
- package/temp-contents.js +10 -29
- package/temp-contents.mjs +5 -24
- package/tenants.d.mts +12 -0
- package/tenants.d.ts +12 -0
- package/tenants.js +14 -9
- package/tenants.mjs +7 -2
- package/themes.d.mts +26 -2
- package/themes.d.ts +26 -2
- package/themes.js +13 -10
- package/themes.mjs +5 -2
- package/transports.d.mts +12 -0
- package/transports.d.ts +12 -0
- package/transports.js +12 -9
- package/transports.mjs +5 -2
- package/users.d.mts +48 -29
- package/users.d.ts +48 -29
- package/users.js +18 -13
- package/users.mjs +7 -2
- package/web-integrations.d.mts +10 -0
- package/web-integrations.d.ts +10 -0
- package/web-integrations.js +11 -8
- package/web-integrations.mjs +5 -2
- package/web-notifications.d.mts +12 -0
- package/web-notifications.d.ts +12 -0
- package/web-notifications.js +12 -9
- package/web-notifications.mjs +5 -2
- package/webhooks.d.mts +27 -7
- package/webhooks.d.ts +27 -7
- package/webhooks.js +17 -13
- package/webhooks.mjs +6 -2
- package/auth-CSVTXOZX.js +0 -36
- package/invoke-fetch-PEI54KZO.js +0 -14
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,31 +218,33 @@ type CreateAutomationHttpError = {
|
|
|
216
218
|
};
|
|
217
219
|
/**
|
|
218
220
|
* Retrieves the automation settings.
|
|
219
|
-
*
|
|
221
|
+
*
|
|
222
|
+
* @throws GetAutomationsSettingsHttpError
|
|
220
223
|
*/
|
|
221
|
-
declare const
|
|
222
|
-
type
|
|
224
|
+
declare const getAutomationsSettings: (options?: ApiCallOptions) => Promise<GetAutomationsSettingsHttpResponse>;
|
|
225
|
+
type GetAutomationsSettingsHttpResponse = {
|
|
223
226
|
data: SettingsObject;
|
|
224
227
|
headers: Headers;
|
|
225
228
|
status: number;
|
|
226
229
|
};
|
|
227
|
-
type
|
|
230
|
+
type GetAutomationsSettingsHttpError = {
|
|
228
231
|
data: ErrorResponse;
|
|
229
232
|
headers: Headers;
|
|
230
233
|
status: number;
|
|
231
234
|
};
|
|
232
235
|
/**
|
|
233
236
|
* Update the automation settings.
|
|
237
|
+
*
|
|
234
238
|
* @param body an object with the body content
|
|
235
|
-
* @throws
|
|
239
|
+
* @throws UpdateAutomationsSettingsHttpError
|
|
236
240
|
*/
|
|
237
|
-
declare const
|
|
238
|
-
type
|
|
241
|
+
declare const updateAutomationsSettings: (body: SettingsObject, options?: ApiCallOptions) => Promise<UpdateAutomationsSettingsHttpResponse>;
|
|
242
|
+
type UpdateAutomationsSettingsHttpResponse = {
|
|
239
243
|
data: SettingsObject;
|
|
240
244
|
headers: Headers;
|
|
241
245
|
status: number;
|
|
242
246
|
};
|
|
243
|
-
type
|
|
247
|
+
type UpdateAutomationsSettingsHttpError = {
|
|
244
248
|
data: ErrorResponse;
|
|
245
249
|
headers: Headers;
|
|
246
250
|
status: number;
|
|
@@ -248,27 +252,29 @@ type UpdateAutomationSettingsHttpError = {
|
|
|
248
252
|
/**
|
|
249
253
|
* **Limitations:**
|
|
250
254
|
* * **Maximum 1000 metrics per API call**
|
|
255
|
+
*
|
|
251
256
|
* @param query an object with query parameters
|
|
252
|
-
* @throws
|
|
257
|
+
* @throws GetAutomationsUsageMetricsHttpError
|
|
253
258
|
*/
|
|
254
|
-
declare const
|
|
259
|
+
declare const getAutomationsUsageMetrics: (query: {
|
|
255
260
|
/** If specified, result will be broken apart for each automation */
|
|
256
261
|
breakdownBy?: string;
|
|
257
262
|
/** Indicates how the metrics should be filtered */
|
|
258
263
|
filter?: string;
|
|
259
|
-
}, options?: ApiCallOptions) => Promise<
|
|
260
|
-
type
|
|
264
|
+
}, options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
|
|
265
|
+
type GetAutomationsUsageMetricsHttpResponse = {
|
|
261
266
|
data: UsageList;
|
|
262
267
|
headers: Headers;
|
|
263
268
|
status: number;
|
|
264
269
|
};
|
|
265
|
-
type
|
|
270
|
+
type GetAutomationsUsageMetricsHttpError = {
|
|
266
271
|
data: ErrorResponse;
|
|
267
272
|
headers: Headers;
|
|
268
273
|
status: number;
|
|
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,48 +528,56 @@ 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.
|
|
525
|
-
*
|
|
545
|
+
*
|
|
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
|
-
* @throws
|
|
553
|
+
* @throws UpdateAutomationsSettingsHttpError
|
|
532
554
|
*/
|
|
533
|
-
|
|
555
|
+
updateAutomationsSettings: typeof updateAutomationsSettings;
|
|
534
556
|
/**
|
|
535
557
|
* **Limitations:**
|
|
536
558
|
* * **Maximum 1000 metrics per API call**
|
|
559
|
+
*
|
|
537
560
|
* @param query an object with query parameters
|
|
538
|
-
* @throws
|
|
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
|
|
@@ -635,4 +671,4 @@ interface AutomationsAPI {
|
|
|
635
671
|
*/
|
|
636
672
|
declare const automationsExport: AutomationsAPI;
|
|
637
673
|
|
|
638
|
-
export { type AutomationDetailRequestObject, type AutomationDetailResponseObject, type AutomationList, type AutomationListObject, type AutomationUsageObject, type AutomationsAPI, type CopyAutomationHttpError, type CopyAutomationHttpResponse, type CreateAutomationHttpError, type CreateAutomationHttpResponse, type DeleteAutomationHttpError, type DeleteAutomationHttpResponse, type DisableAutomationHttpError, type DisableAutomationHttpResponse, type EnableAutomationHttpError, type EnableAutomationHttpResponse, type Error, type ErrorResponse, type GetAutomationHttpError, type GetAutomationHttpResponse, type GetAutomationRunDetailsHttpError, type GetAutomationRunDetailsHttpResponse, type GetAutomationRunHttpError, type GetAutomationRunHttpResponse, type GetAutomationRunsHttpError, type GetAutomationRunsHttpResponse, type
|
|
674
|
+
export { type AutomationDetailRequestObject, type AutomationDetailResponseObject, type AutomationList, type AutomationListObject, type AutomationUsageObject, type AutomationsAPI, type CopyAutomationHttpError, type CopyAutomationHttpResponse, type CreateAutomationHttpError, type CreateAutomationHttpResponse, type DeleteAutomationHttpError, type DeleteAutomationHttpResponse, type DisableAutomationHttpError, type DisableAutomationHttpResponse, type EnableAutomationHttpError, type EnableAutomationHttpResponse, type Error, type ErrorResponse, type GetAutomationHttpError, type GetAutomationHttpResponse, type GetAutomationRunDetailsHttpError, type GetAutomationRunDetailsHttpResponse, type GetAutomationRunHttpError, type GetAutomationRunHttpResponse, type GetAutomationRunsHttpError, type GetAutomationRunsHttpResponse, type GetAutomationsHttpError, type GetAutomationsHttpResponse, type GetAutomationsSettingsHttpError, type GetAutomationsSettingsHttpResponse, type GetAutomationsUsageMetricsHttpError, type GetAutomationsUsageMetricsHttpResponse, type Links, type MoveAutomationHttpError, type MoveAutomationHttpResponse, type PaginationLink, type QueueAutomationRunHttpError, type QueueAutomationRunHttpResponse, type RetryAutomationRunHttpError, type RetryAutomationRunHttpResponse, type RunDetailRequestObject, type RunDetailResponseObject, type RunList, type RunListObject, type ScheduleRequestObject, type ScheduleResponseObject, type SettingsObject, type StopAutomationRunHttpError, type StopAutomationRunHttpResponse, type UpdateAutomationHttpError, type UpdateAutomationHttpResponse, type UpdateAutomationsSettingsHttpError, type UpdateAutomationsSettingsHttpResponse, type UsageList, type UsageObject, clearCache, copyAutomation, createAutomation, automationsExport as default, deleteAutomation, disableAutomation, enableAutomation, getAutomation, getAutomationRun, getAutomationRunDetails, getAutomationRuns, getAutomations, getAutomationsSettings, getAutomationsUsageMetrics, moveAutomation, queueAutomationRun, retryAutomationRun, stopAutomationRun, updateAutomation, updateAutomationsSettings };
|
package/automations.d.ts
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,31 +218,33 @@ type CreateAutomationHttpError = {
|
|
|
216
218
|
};
|
|
217
219
|
/**
|
|
218
220
|
* Retrieves the automation settings.
|
|
219
|
-
*
|
|
221
|
+
*
|
|
222
|
+
* @throws GetAutomationsSettingsHttpError
|
|
220
223
|
*/
|
|
221
|
-
declare const
|
|
222
|
-
type
|
|
224
|
+
declare const getAutomationsSettings: (options?: ApiCallOptions) => Promise<GetAutomationsSettingsHttpResponse>;
|
|
225
|
+
type GetAutomationsSettingsHttpResponse = {
|
|
223
226
|
data: SettingsObject;
|
|
224
227
|
headers: Headers;
|
|
225
228
|
status: number;
|
|
226
229
|
};
|
|
227
|
-
type
|
|
230
|
+
type GetAutomationsSettingsHttpError = {
|
|
228
231
|
data: ErrorResponse;
|
|
229
232
|
headers: Headers;
|
|
230
233
|
status: number;
|
|
231
234
|
};
|
|
232
235
|
/**
|
|
233
236
|
* Update the automation settings.
|
|
237
|
+
*
|
|
234
238
|
* @param body an object with the body content
|
|
235
|
-
* @throws
|
|
239
|
+
* @throws UpdateAutomationsSettingsHttpError
|
|
236
240
|
*/
|
|
237
|
-
declare const
|
|
238
|
-
type
|
|
241
|
+
declare const updateAutomationsSettings: (body: SettingsObject, options?: ApiCallOptions) => Promise<UpdateAutomationsSettingsHttpResponse>;
|
|
242
|
+
type UpdateAutomationsSettingsHttpResponse = {
|
|
239
243
|
data: SettingsObject;
|
|
240
244
|
headers: Headers;
|
|
241
245
|
status: number;
|
|
242
246
|
};
|
|
243
|
-
type
|
|
247
|
+
type UpdateAutomationsSettingsHttpError = {
|
|
244
248
|
data: ErrorResponse;
|
|
245
249
|
headers: Headers;
|
|
246
250
|
status: number;
|
|
@@ -248,27 +252,29 @@ type UpdateAutomationSettingsHttpError = {
|
|
|
248
252
|
/**
|
|
249
253
|
* **Limitations:**
|
|
250
254
|
* * **Maximum 1000 metrics per API call**
|
|
255
|
+
*
|
|
251
256
|
* @param query an object with query parameters
|
|
252
|
-
* @throws
|
|
257
|
+
* @throws GetAutomationsUsageMetricsHttpError
|
|
253
258
|
*/
|
|
254
|
-
declare const
|
|
259
|
+
declare const getAutomationsUsageMetrics: (query: {
|
|
255
260
|
/** If specified, result will be broken apart for each automation */
|
|
256
261
|
breakdownBy?: string;
|
|
257
262
|
/** Indicates how the metrics should be filtered */
|
|
258
263
|
filter?: string;
|
|
259
|
-
}, options?: ApiCallOptions) => Promise<
|
|
260
|
-
type
|
|
264
|
+
}, options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
|
|
265
|
+
type GetAutomationsUsageMetricsHttpResponse = {
|
|
261
266
|
data: UsageList;
|
|
262
267
|
headers: Headers;
|
|
263
268
|
status: number;
|
|
264
269
|
};
|
|
265
|
-
type
|
|
270
|
+
type GetAutomationsUsageMetricsHttpError = {
|
|
266
271
|
data: ErrorResponse;
|
|
267
272
|
headers: Headers;
|
|
268
273
|
status: number;
|
|
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,48 +528,56 @@ 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.
|
|
525
|
-
*
|
|
545
|
+
*
|
|
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
|
-
* @throws
|
|
553
|
+
* @throws UpdateAutomationsSettingsHttpError
|
|
532
554
|
*/
|
|
533
|
-
|
|
555
|
+
updateAutomationsSettings: typeof updateAutomationsSettings;
|
|
534
556
|
/**
|
|
535
557
|
* **Limitations:**
|
|
536
558
|
* * **Maximum 1000 metrics per API call**
|
|
559
|
+
*
|
|
537
560
|
* @param query an object with query parameters
|
|
538
|
-
* @throws
|
|
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
|
|
@@ -635,4 +671,4 @@ interface AutomationsAPI {
|
|
|
635
671
|
*/
|
|
636
672
|
declare const automationsExport: AutomationsAPI;
|
|
637
673
|
|
|
638
|
-
export { type AutomationDetailRequestObject, type AutomationDetailResponseObject, type AutomationList, type AutomationListObject, type AutomationUsageObject, type AutomationsAPI, type CopyAutomationHttpError, type CopyAutomationHttpResponse, type CreateAutomationHttpError, type CreateAutomationHttpResponse, type DeleteAutomationHttpError, type DeleteAutomationHttpResponse, type DisableAutomationHttpError, type DisableAutomationHttpResponse, type EnableAutomationHttpError, type EnableAutomationHttpResponse, type Error, type ErrorResponse, type GetAutomationHttpError, type GetAutomationHttpResponse, type GetAutomationRunDetailsHttpError, type GetAutomationRunDetailsHttpResponse, type GetAutomationRunHttpError, type GetAutomationRunHttpResponse, type GetAutomationRunsHttpError, type GetAutomationRunsHttpResponse, type
|
|
674
|
+
export { type AutomationDetailRequestObject, type AutomationDetailResponseObject, type AutomationList, type AutomationListObject, type AutomationUsageObject, type AutomationsAPI, type CopyAutomationHttpError, type CopyAutomationHttpResponse, type CreateAutomationHttpError, type CreateAutomationHttpResponse, type DeleteAutomationHttpError, type DeleteAutomationHttpResponse, type DisableAutomationHttpError, type DisableAutomationHttpResponse, type EnableAutomationHttpError, type EnableAutomationHttpResponse, type Error, type ErrorResponse, type GetAutomationHttpError, type GetAutomationHttpResponse, type GetAutomationRunDetailsHttpError, type GetAutomationRunDetailsHttpResponse, type GetAutomationRunHttpError, type GetAutomationRunHttpResponse, type GetAutomationRunsHttpError, type GetAutomationRunsHttpResponse, type GetAutomationsHttpError, type GetAutomationsHttpResponse, type GetAutomationsSettingsHttpError, type GetAutomationsSettingsHttpResponse, type GetAutomationsUsageMetricsHttpError, type GetAutomationsUsageMetricsHttpResponse, type Links, type MoveAutomationHttpError, type MoveAutomationHttpResponse, type PaginationLink, type QueueAutomationRunHttpError, type QueueAutomationRunHttpResponse, type RetryAutomationRunHttpError, type RetryAutomationRunHttpResponse, type RunDetailRequestObject, type RunDetailResponseObject, type RunList, type RunListObject, type ScheduleRequestObject, type ScheduleResponseObject, type SettingsObject, type StopAutomationRunHttpError, type StopAutomationRunHttpResponse, type UpdateAutomationHttpError, type UpdateAutomationHttpResponse, type UpdateAutomationsSettingsHttpError, type UpdateAutomationsSettingsHttpResponse, type UsageList, type UsageObject, clearCache, copyAutomation, createAutomation, automationsExport as default, deleteAutomation, disableAutomation, enableAutomation, getAutomation, getAutomationRun, getAutomationRunDetails, getAutomationRuns, getAutomations, getAutomationsSettings, getAutomationsUsageMetrics, moveAutomation, queueAutomationRun, retryAutomationRun, stopAutomationRun, updateAutomation, updateAutomationsSettings };
|