@qlik/api 0.0.16 → 0.1.1

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