-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathautomations.d.ts
706 lines (704 loc) · 26.6 KB
/
automations.d.ts
1
2
3
4
5
6
7
8
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
import './auth-types-PkN9CAF_.js';
type AutomationDetailRequestObject = {
description?: string;
name?: string;
schedules?: ScheduleRequestObject[];
state?: "available" | "unavailable" | "disabled";
/** The workspace generated by the Qlik Application Automations editor. */
workspace?: unknown;
};
type AutomationDetailResponseObject = {
/** A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */
readonly connectorIds?: string[];
readonly createdAt?: string;
description?: string;
/** A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */
readonly endpointIds?: string[];
readonly executionToken?: string;
readonly id?: string;
lastRun?: RunDetailResponseObject;
readonly lastRunAt?: string;
readonly lastRunStatus?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "paused" | "running" | "starting" | "stopped";
name?: string;
readonly ownerId?: string;
readonly runMode?: "manual" | "scheduled" | "triggered" | "webhook";
schedules?: ScheduleResponseObject[];
/** A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed. */
readonly snippetIds?: string[];
state?: "available" | "unavailable" | "disabled";
readonly updatedAt?: string;
/** The workspace generated by the Qlik Application Automations editor. */
workspace?: unknown;
};
type AutomationList = {
data?: AutomationListObject[];
links?: Links;
};
type AutomationListObject = {
/** A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */
readonly connectorIds?: string[];
readonly createdAt?: string;
description?: string;
/** Duration of the last run, indicated in seconds. Calculated from start and stop times */
readonly duration?: number;
/** A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */
readonly endpointIds?: string[];
readonly executionToken?: string;
readonly id?: string;
lastRun?: RunDetailResponseObject;
readonly lastRunAt?: string;
readonly lastRunStatus?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "paused" | "running" | "starting" | "stopped";
name?: string;
readonly ownerId?: string;
readonly runMode?: "manual" | "scheduled" | "triggered" | "webhook";
/** A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed. */
readonly snippetIds?: string[];
state?: "available" | "unavailable" | "disabled";
readonly updatedAt?: string;
/** The workspace contains the JSON representation of the used blocks */
readonly workspace?: unknown;
};
type AutomationUsageObject = {
/** Duration of the last run, indicated in seconds. Calculated from start and stop times */
duration?: number;
/** The unique identifier for the automation. */
guid?: string;
/** The name for the automation. */
name?: string;
/** The unique identifier for the user who owns the automation */
ownerId?: string;
};
type Error = {
/** The unique code for the error */
code: string;
/** May be used to provide additional details */
detail?: string;
/** A summary of what went wrong */
title: string;
};
type ErrorResponse = {
errors?: Error[];
/** A way to trace the source of the error. */
traceId?: string;
};
type Links = {
next?: PaginationLink;
prev?: PaginationLink;
};
type PaginationLink = {
/** The URL to a resource request */
href?: string;
};
type RunDetailRequestObject = {
/** The source that triggers the automation will set the context. */
context: "api";
readonly id?: string;
};
type RunDetailResponseObject = {
/** The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). */
context?: "test_run" | "editor" | "detail" | "api_sync" | "api_async" | "webhook" | "lookup";
readonly createdAt?: string;
error?: unknown;
readonly id?: string;
readonly isArchived?: boolean;
readonly isTestRun?: boolean;
metrics?: {
/** List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks */
blocks?: {
/** API calls to external resources made by the current block. */
apiCalls?: number;
/** Unique identifier for the connector used within the block of the execution. */
connectorId?: string;
/** Unique identifier for the snippet block used within the execution. */
endpointId?: string;
/** Total amount of received bytes sent by the current block. */
rxBytes: number;
/** Unique identifier for the snippet block used within the execution. */
snippetId?: string;
/** Total amount of sent bytes sent by the current block. */
txBytes: number;
/** Type of the block. */
type: "snippetBlock" | "endpointBlock";
}[];
network?: {
/** The number of received bytes. */
rxBytes?: number;
/** The number of received bytes. */
txBytes?: number;
};
/** The number of API calls made. */
totalApiCalls?: number;
};
readonly scheduledStartTime?: string;
readonly startTime?: string;
status?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "running" | "starting" | "stopped";
readonly stopTime?: string;
title?: string;
readonly updatedAt?: string;
};
type RunList = {
data?: RunListObject[];
links?: Links;
};
type RunListObject = {
context?: "test_run" | "editor" | "detail" | "api_sync" | "api_async" | "webhook" | "lookup";
readonly createdAt?: string;
/** Duration of the run, indicated in seconds. Calculated from start and stop times */
readonly duration?: number;
error?: unknown;
readonly id?: string;
readonly isArchived?: boolean;
readonly isTestRun?: boolean;
readonly scheduledStartTime?: string;
readonly startTime?: string;
status?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "running" | "starting" | "stopped";
readonly stopTime?: string;
title?: string;
readonly updatedAt?: string;
};
type ScheduleRequestObject = {
/** time in seconds. */
interval?: number;
startAt?: string;
stopAt?: string;
timezone?: string;
};
type ScheduleResponseObject = {
readonly id?: string;
/** time in seconds. */
interval?: number;
lastStartedAt?: string;
startAt?: string;
stopAt?: string;
timezone?: string;
};
type UsageList = {
data?: UsageObject[];
links?: Links;
};
type UsageObject = {
automation?: AutomationUsageObject;
/** The date for the metric */
date: string;
/** The name for the metric */
name: "runs" | "scheduledRun" | "triggeredRun" | "webhookRuns" | "duration" | "bandwidthIn" | "bandwidthOut";
/** The value count of the metric */
value: number;
};
/**
* Retrieves a list of automations
*
* @param query an object with query parameters
* @throws GetAutomationsHttpError
*/
declare const getAutomations: (query: {
/** Allows to select the actual fields to be returned. When no fields are defined, all are returned. */
fields?: string;
/** Allowed filters: name, runMode, lastRunStatus, ownerId */
filter?: string;
/** The number of automations to retrieve. */
limit?: number;
/** The field to sort by, with +- prefix indicating sort order. (?query=-name => sort on the name field using descending order) */
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";
}, options?: ApiCallOptions) => Promise<GetAutomationsHttpResponse>;
type GetAutomationsHttpResponse = {
data: AutomationList;
headers: Headers;
status: 200;
prev?: (options?: ApiCallOptions) => Promise<GetAutomationsHttpResponse>;
next?: (options?: ApiCallOptions) => Promise<GetAutomationsHttpResponse>;
};
type GetAutomationsHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 500 | 503;
};
/**
* Create an automation
*
* @param body an object with the body content
* @throws CreateAutomationHttpError
*/
declare const createAutomation: (body: AutomationDetailRequestObject, options?: ApiCallOptions) => Promise<CreateAutomationHttpResponse>;
type CreateAutomationHttpResponse = {
data: AutomationDetailResponseObject;
headers: Headers;
status: 201;
};
type CreateAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 500 | 503;
};
/**
* Retrieves all automation usage for a tenant
*
* @param query an object with query parameters
* @throws GetAutomationsUsageMetricsHttpError
*/
declare const getAutomationsUsageMetrics: (query: {
/** If specified, result will be broken apart for each automation */
breakdownBy?: string;
/** Indicates how the metrics should be filtered */
filter?: string;
}, options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
type GetAutomationsUsageMetricsHttpResponse = {
data: UsageList;
headers: Headers;
status: 200;
prev?: (options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
next?: (options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
};
type GetAutomationsUsageMetricsHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 500 | 503;
};
/**
* Delete an automation
*
* @param id The unique identifier for the automation.
* @throws DeleteAutomationHttpError
*/
declare const deleteAutomation: (id: string, options?: ApiCallOptions) => Promise<DeleteAutomationHttpResponse>;
type DeleteAutomationHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type DeleteAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 401 | 403 | 404 | 500 | 503;
};
/**
* Retrieves an automation
*
* @param id The unique identifier for the automation.
* @param query an object with query parameters
* @throws GetAutomationWithQueryHttpError
*/
declare const getAutomationWithQuery: (id: string, query: {
/** Allows to select the actual fields to be returned. Where the default is all fields */
fields?: string;
}, options?: ApiCallOptions) => Promise<GetAutomationWithQueryHttpResponse>;
type GetAutomationWithQueryHttpResponse = {
data: AutomationDetailResponseObject;
headers: Headers;
status: 200;
};
type GetAutomationWithQueryHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Retrieves an automation
*
* @param id The unique identifier for the automation.
* @throws GetAutomationHttpError
*/
declare const getAutomation: (id: string, options?: ApiCallOptions) => Promise<GetAutomationHttpResponse>;
type GetAutomationHttpResponse = {
data: AutomationDetailResponseObject;
headers: Headers;
status: 200;
};
type GetAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Update an automation
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws UpdateAutomationHttpError
*/
declare const updateAutomation: (id: string, body: AutomationDetailRequestObject, options?: ApiCallOptions) => Promise<UpdateAutomationHttpResponse>;
type UpdateAutomationHttpResponse = {
data: AutomationDetailResponseObject;
headers: Headers;
status: 200;
};
type UpdateAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Copy an automation.
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws CopyAutomationHttpError
*/
declare const copyAutomation: (id: string, body: {
/** Name of the new automation. */
name: string;
}, options?: ApiCallOptions) => Promise<CopyAutomationHttpResponse>;
type CopyAutomationHttpResponse = {
data: {
/** The unique identifier for the automation. */
id?: string;
};
headers: Headers;
status: 201;
};
type CopyAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Disables an automation.
*
* @param id The unique identifier for the automation.
* @throws DisableAutomationHttpError
*/
declare const disableAutomation: (id: string, options?: ApiCallOptions) => Promise<DisableAutomationHttpResponse>;
type DisableAutomationHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type DisableAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Enable an automation.
*
* @param id The unique identifier for the automation.
* @throws EnableAutomationHttpError
*/
declare const enableAutomation: (id: string, options?: ApiCallOptions) => Promise<EnableAutomationHttpResponse>;
type EnableAutomationHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type EnableAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws MoveAutomationHttpError
*/
declare const moveAutomation: (id: string, body: {
userId: string;
}, options?: ApiCallOptions) => Promise<MoveAutomationHttpResponse>;
type MoveAutomationHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type MoveAutomationHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Retrieves a list of runs for a specific automation.
*
* @param id The unique identifier for the automation.
* @param query an object with query parameters
* @throws GetAutomationRunsHttpError
*/
declare const getAutomationRuns: (id: string, query: {
/** Allows to select the actual fields to be returned. Where the default is all fields */
fields?: string;
/** Allowed filters: status, context, startTime and title */
filter?: string;
/** The number of runs to retrieve. */
limit?: number;
/** The field to sort by, with +- prefix indicating sort order. (?query=-startTime => sort on the startTime field using descending order) */
sort?: "id" | "status" | "startTime" | "-id" | "-status" | "-startTime" | "+id" | "+status" | "+startTime";
}, options?: ApiCallOptions) => Promise<GetAutomationRunsHttpResponse>;
type GetAutomationRunsHttpResponse = {
data: RunList;
headers: Headers;
status: 200;
prev?: (options?: ApiCallOptions) => Promise<GetAutomationRunsHttpResponse>;
next?: (options?: ApiCallOptions) => Promise<GetAutomationRunsHttpResponse>;
};
type GetAutomationRunsHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Create a run
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws QueueAutomationRunHttpError
*/
declare const queueAutomationRun: (id: string, body: RunDetailRequestObject, options?: ApiCallOptions) => Promise<QueueAutomationRunHttpResponse>;
type QueueAutomationRunHttpResponse = {
data: RunDetailResponseObject;
headers: Headers;
status: 201;
};
type QueueAutomationRunHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Retrieves a run
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @param query an object with query parameters
* @throws GetAutomationRunWithQueryHttpError
*/
declare const getAutomationRunWithQuery: (id: string, runId: string, query: {
/** Allows to select the actual fields to be returned. Where the default is all fields */
fields?: string;
}, options?: ApiCallOptions) => Promise<GetAutomationRunWithQueryHttpResponse>;
type GetAutomationRunWithQueryHttpResponse = {
data: RunDetailResponseObject;
headers: Headers;
status: 200;
};
type GetAutomationRunWithQueryHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Retrieves a run
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws GetAutomationRunHttpError
*/
declare const getAutomationRun: (id: string, runId: string, options?: ApiCallOptions) => Promise<GetAutomationRunHttpResponse>;
type GetAutomationRunHttpResponse = {
data: RunDetailResponseObject;
headers: Headers;
status: 200;
};
type GetAutomationRunHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws GetAutomationRunDetailsHttpError
*/
declare const getAutomationRunDetails: (id: string, runId: string, options?: ApiCallOptions) => Promise<GetAutomationRunDetailsHttpResponse>;
type GetAutomationRunDetailsHttpResponse = {
data: {
url?: string;
};
headers: Headers;
status: 200;
};
type GetAutomationRunDetailsHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* This action allows you to retry a specific run by creating a new run using the same inputs.
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws RetryAutomationRunHttpError
*/
declare const retryAutomationRun: (id: string, runId: string, options?: ApiCallOptions) => Promise<RetryAutomationRunHttpResponse>;
type RetryAutomationRunHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type RetryAutomationRunHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Force a run to be stopped immediately.
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws StopAutomationRunHttpError
*/
declare const stopAutomationRun: (id: string, runId: string, options?: ApiCallOptions) => Promise<StopAutomationRunHttpResponse>;
type StopAutomationRunHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type StopAutomationRunHttpError = {
data: ErrorResponse;
headers: Headers;
status: 400 | 401 | 403 | 404 | 500 | 503;
};
/**
* Clears the cache for automations api requests.
*/
declare function clearCache(): void;
interface AutomationsAPI {
/**
* Retrieves a list of automations
*
* @param query an object with query parameters
* @throws GetAutomationsHttpError
*/
getAutomations: typeof getAutomations;
/**
* Create an automation
*
* @param body an object with the body content
* @throws CreateAutomationHttpError
*/
createAutomation: typeof createAutomation;
/**
* Retrieves all automation usage for a tenant
*
* @param query an object with query parameters
* @throws GetAutomationsUsageMetricsHttpError
*/
getAutomationsUsageMetrics: typeof getAutomationsUsageMetrics;
/**
* Delete an automation
*
* @param id The unique identifier for the automation.
* @throws DeleteAutomationHttpError
*/
deleteAutomation: typeof deleteAutomation;
/**
* Retrieves an automation
*
* @param id The unique identifier for the automation.
* @param query an object with query parameters
* @throws GetAutomationWithQueryHttpError
*/
getAutomationWithQuery: typeof getAutomationWithQuery;
/**
* Retrieves an automation
*
* @param id The unique identifier for the automation.
* @throws GetAutomationHttpError
*/
getAutomation: typeof getAutomation;
/**
* Update an automation
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws UpdateAutomationHttpError
*/
updateAutomation: typeof updateAutomation;
/**
* Copy an automation.
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws CopyAutomationHttpError
*/
copyAutomation: typeof copyAutomation;
/**
* Disables an automation.
*
* @param id The unique identifier for the automation.
* @throws DisableAutomationHttpError
*/
disableAutomation: typeof disableAutomation;
/**
* Enable an automation.
*
* @param id The unique identifier for the automation.
* @throws EnableAutomationHttpError
*/
enableAutomation: typeof enableAutomation;
/**
* This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws MoveAutomationHttpError
*/
moveAutomation: typeof moveAutomation;
/**
* Retrieves a list of runs for a specific automation.
*
* @param id The unique identifier for the automation.
* @param query an object with query parameters
* @throws GetAutomationRunsHttpError
*/
getAutomationRuns: typeof getAutomationRuns;
/**
* Create a run
*
* @param id The unique identifier for the automation.
* @param body an object with the body content
* @throws QueueAutomationRunHttpError
*/
queueAutomationRun: typeof queueAutomationRun;
/**
* Retrieves a run
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @param query an object with query parameters
* @throws GetAutomationRunWithQueryHttpError
*/
getAutomationRunWithQuery: typeof getAutomationRunWithQuery;
/**
* Retrieves a run
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws GetAutomationRunHttpError
*/
getAutomationRun: typeof getAutomationRun;
/**
* Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws GetAutomationRunDetailsHttpError
*/
getAutomationRunDetails: typeof getAutomationRunDetails;
/**
* This action allows you to retry a specific run by creating a new run using the same inputs.
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws RetryAutomationRunHttpError
*/
retryAutomationRun: typeof retryAutomationRun;
/**
* Force a run to be stopped immediately.
*
* @param id The unique identifier for the automation.
* @param runId The unique identifier for the run.
* @throws StopAutomationRunHttpError
*/
stopAutomationRun: typeof stopAutomationRun;
/**
* Clears the cache for automations api requests.
*/
clearCache: typeof clearCache;
}
/**
* Functions for the automations api
*/
declare const automationsExport: AutomationsAPI;
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 GetAutomationRunWithQueryHttpError, type GetAutomationRunWithQueryHttpResponse, type GetAutomationRunsHttpError, type GetAutomationRunsHttpResponse, type GetAutomationWithQueryHttpError, type GetAutomationWithQueryHttpResponse, type GetAutomationsHttpError, type GetAutomationsHttpResponse, 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 StopAutomationRunHttpError, type StopAutomationRunHttpResponse, type UpdateAutomationHttpError, type UpdateAutomationHttpResponse, type UsageList, type UsageObject, clearCache, copyAutomation, createAutomation, automationsExport as default, deleteAutomation, disableAutomation, enableAutomation, getAutomation, getAutomationRun, getAutomationRunDetails, getAutomationRunWithQuery, getAutomationRuns, getAutomationWithQuery, getAutomations, getAutomationsUsageMetrics, moveAutomation, queueAutomationRun, retryAutomationRun, stopAutomationRun, updateAutomation };