@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.
Files changed (156) hide show
  1. package/.github/CODEOWNERS +2 -0
  2. package/.github/workflows/release.yaml +35 -0
  3. package/README.md +1 -3
  4. package/api-keys.d.mts +27 -13
  5. package/api-keys.d.ts +27 -13
  6. package/api-keys.js +17 -13
  7. package/api-keys.mjs +12 -8
  8. package/apps.d.mts +580 -165
  9. package/apps.d.ts +580 -165
  10. package/apps.js +111 -44
  11. package/apps.mjs +78 -11
  12. package/audits.d.mts +20 -8
  13. package/audits.d.ts +20 -8
  14. package/audits.js +12 -11
  15. package/audits.mjs +7 -6
  16. package/auth-AWZV4DPP.js +41 -0
  17. package/{auth-TE272Q34.mjs → auth-CPBNNC7S.mjs} +8 -3
  18. package/auth.js +4 -3
  19. package/auth.mjs +3 -2
  20. package/automations.d.mts +56 -20
  21. package/automations.d.ts +56 -20
  22. package/automations.js +32 -25
  23. package/automations.mjs +18 -11
  24. package/brands.d.mts +45 -4
  25. package/brands.d.ts +45 -4
  26. package/brands.js +20 -15
  27. package/brands.mjs +7 -2
  28. package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
  29. package/{chunk-WM7FQU2U.mjs → chunk-3SVRHJII.mjs} +3 -3
  30. package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
  31. package/{chunk-4ES65KO3.js → chunk-7RY3NO6N.js} +2 -2
  32. package/{chunk-4OMEH5SW.mjs → chunk-CYRLVHU3.mjs} +321 -53
  33. package/{chunk-XASXL2NC.js → chunk-D52VW5UN.js} +323 -55
  34. package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
  35. package/{chunk-4FLMND6T.js → chunk-GV5SRHY2.js} +4 -4
  36. package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
  37. package/chunk-P57PW2II.js +11 -0
  38. package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
  39. package/chunk-ZFXKCRJC.mjs +11 -0
  40. package/collections.d.mts +52 -18
  41. package/collections.d.ts +52 -18
  42. package/collections.js +28 -14
  43. package/collections.mjs +16 -2
  44. package/csp-origins.d.mts +12 -0
  45. package/csp-origins.d.ts +12 -0
  46. package/csp-origins.js +12 -9
  47. package/csp-origins.mjs +5 -2
  48. package/data-assets.d.mts +10 -0
  49. package/data-assets.d.ts +10 -0
  50. package/data-assets.js +13 -8
  51. package/data-assets.mjs +7 -2
  52. package/data-connections.d.mts +20 -0
  53. package/data-connections.d.ts +20 -0
  54. package/data-connections.js +19 -12
  55. package/data-connections.mjs +9 -2
  56. package/data-credentials.d.mts +10 -0
  57. package/data-credentials.d.ts +10 -0
  58. package/data-credentials.js +10 -7
  59. package/data-credentials.mjs +5 -2
  60. package/data-files.d.mts +114 -29
  61. package/data-files.d.ts +114 -29
  62. package/data-files.js +25 -18
  63. package/data-files.mjs +15 -8
  64. package/{enigma-session-TEB53FAF.js → enigma-session-XPXDQAIV.js} +12 -7
  65. package/{enigma-session-4L373ALV.mjs → enigma-session-ZH6MYA54.mjs} +10 -5
  66. package/{esm-4X3DKK5D.js → esm-3VXX2GKL.js} +13 -9
  67. package/{esm-SOWVJKOQ.mjs → esm-OY4XVIJB.mjs} +13 -9
  68. package/extensions.d.mts +26 -2
  69. package/extensions.d.ts +26 -2
  70. package/extensions.js +13 -10
  71. package/extensions.mjs +5 -2
  72. package/glossaries.d.mts +55 -20
  73. package/glossaries.d.ts +55 -20
  74. package/glossaries.js +39 -27
  75. package/glossaries.mjs +14 -2
  76. package/groups.d.mts +29 -13
  77. package/groups.d.ts +29 -13
  78. package/groups.js +19 -14
  79. package/groups.mjs +13 -8
  80. package/identity-providers.d.mts +23 -7
  81. package/identity-providers.d.ts +23 -7
  82. package/identity-providers.js +16 -13
  83. package/identity-providers.mjs +8 -5
  84. package/index.js +150 -112
  85. package/index.mjs +146 -108
  86. package/{invoke-fetch-MSSJAZ7K.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
  87. package/invoke-fetch-UNTAUR7O.js +17 -0
  88. package/items.d.mts +25 -22
  89. package/items.d.ts +25 -22
  90. package/items.js +17 -14
  91. package/items.mjs +11 -8
  92. package/licenses.d.mts +20 -0
  93. package/licenses.d.ts +20 -0
  94. package/licenses.js +17 -12
  95. package/licenses.mjs +7 -2
  96. package/package.json +7 -18
  97. package/{qix-RLTISYTB.js → qix-UNWXPGMA.js} +9 -8
  98. package/{qix-EU7PXRZ6.mjs → qix-ZSJ4PIK3.mjs} +5 -4
  99. package/qix.d.mts +1066 -1017
  100. package/qix.d.ts +1066 -1017
  101. package/qix.js +4 -3
  102. package/qix.mjs +3 -2
  103. package/quotas.d.mts +4 -0
  104. package/quotas.d.ts +4 -0
  105. package/quotas.js +6 -5
  106. package/quotas.mjs +3 -2
  107. package/reload-tasks.d.mts +2 -0
  108. package/reload-tasks.d.ts +2 -0
  109. package/reload-tasks.js +11 -8
  110. package/reload-tasks.mjs +5 -2
  111. package/reloads.d.mts +20 -11
  112. package/reloads.d.ts +20 -11
  113. package/reloads.js +9 -7
  114. package/reloads.mjs +4 -2
  115. package/roles.d.mts +4 -0
  116. package/roles.d.ts +4 -0
  117. package/roles.js +6 -5
  118. package/roles.mjs +3 -2
  119. package/spaces.d.mts +36 -30
  120. package/spaces.d.ts +36 -30
  121. package/spaces.js +21 -15
  122. package/spaces.mjs +8 -2
  123. package/temp-contents.d.mts +9 -70
  124. package/temp-contents.d.ts +9 -70
  125. package/temp-contents.js +10 -29
  126. package/temp-contents.mjs +5 -24
  127. package/tenants.d.mts +12 -0
  128. package/tenants.d.ts +12 -0
  129. package/tenants.js +14 -9
  130. package/tenants.mjs +7 -2
  131. package/themes.d.mts +26 -2
  132. package/themes.d.ts +26 -2
  133. package/themes.js +13 -10
  134. package/themes.mjs +5 -2
  135. package/transports.d.mts +12 -0
  136. package/transports.d.ts +12 -0
  137. package/transports.js +12 -9
  138. package/transports.mjs +5 -2
  139. package/users.d.mts +48 -29
  140. package/users.d.ts +48 -29
  141. package/users.js +18 -13
  142. package/users.mjs +7 -2
  143. package/web-integrations.d.mts +10 -0
  144. package/web-integrations.d.ts +10 -0
  145. package/web-integrations.js +11 -8
  146. package/web-integrations.mjs +5 -2
  147. package/web-notifications.d.mts +12 -0
  148. package/web-notifications.d.ts +12 -0
  149. package/web-notifications.js +12 -9
  150. package/web-notifications.mjs +5 -2
  151. package/webhooks.d.mts +27 -7
  152. package/webhooks.d.ts +27 -7
  153. package/webhooks.js +17 -13
  154. package/webhooks.mjs +6 -2
  155. package/auth-CSVTXOZX.js +0 -36
  156. 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
- * @throws GetAutomationSettingsHttpError
221
+ *
222
+ * @throws GetAutomationsSettingsHttpError
220
223
  */
221
- declare const getAutomationSettings: (options?: ApiCallOptions) => Promise<GetAutomationSettingsHttpResponse>;
222
- type GetAutomationSettingsHttpResponse = {
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 GetAutomationSettingsHttpError = {
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 UpdateAutomationSettingsHttpError
239
+ * @throws UpdateAutomationsSettingsHttpError
236
240
  */
237
- declare const updateAutomationSettings: (body: SettingsObject, options?: ApiCallOptions) => Promise<UpdateAutomationSettingsHttpResponse>;
238
- type UpdateAutomationSettingsHttpResponse = {
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 UpdateAutomationSettingsHttpError = {
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 GetAutomationUsageMetricsHttpError
257
+ * @throws GetAutomationsUsageMetricsHttpError
253
258
  */
254
- declare const getAutomationUsageMetrics: (query: {
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<GetAutomationUsageMetricsHttpResponse>;
260
- type GetAutomationUsageMetricsHttpResponse = {
264
+ }, options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
265
+ type GetAutomationsUsageMetricsHttpResponse = {
261
266
  data: UsageList;
262
267
  headers: Headers;
263
268
  status: number;
264
269
  };
265
- type GetAutomationUsageMetricsHttpError = {
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
- * @throws GetAutomationSettingsHttpError
545
+ *
546
+ * @throws GetAutomationsSettingsHttpError
526
547
  */
527
- getAutomationSettings: typeof getAutomationSettings;
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 UpdateAutomationSettingsHttpError
553
+ * @throws UpdateAutomationsSettingsHttpError
532
554
  */
533
- updateAutomationSettings: typeof updateAutomationSettings;
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 GetAutomationUsageMetricsHttpError
561
+ * @throws GetAutomationsUsageMetricsHttpError
539
562
  */
540
- getAutomationUsageMetrics: typeof getAutomationUsageMetrics;
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 GetAutomationSettingsHttpError, type GetAutomationSettingsHttpResponse, type GetAutomationUsageMetricsHttpError, type GetAutomationUsageMetricsHttpResponse, type GetAutomationsHttpError, type GetAutomationsHttpResponse, 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 UpdateAutomationSettingsHttpError, type UpdateAutomationSettingsHttpResponse, type UsageList, type UsageObject, clearCache, copyAutomation, createAutomation, automationsExport as default, deleteAutomation, disableAutomation, enableAutomation, getAutomation, getAutomationRun, getAutomationRunDetails, getAutomationRuns, getAutomationSettings, getAutomationUsageMetrics, getAutomations, moveAutomation, queueAutomationRun, retryAutomationRun, stopAutomationRun, updateAutomation, updateAutomationSettings };
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
- * @throws GetAutomationSettingsHttpError
221
+ *
222
+ * @throws GetAutomationsSettingsHttpError
220
223
  */
221
- declare const getAutomationSettings: (options?: ApiCallOptions) => Promise<GetAutomationSettingsHttpResponse>;
222
- type GetAutomationSettingsHttpResponse = {
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 GetAutomationSettingsHttpError = {
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 UpdateAutomationSettingsHttpError
239
+ * @throws UpdateAutomationsSettingsHttpError
236
240
  */
237
- declare const updateAutomationSettings: (body: SettingsObject, options?: ApiCallOptions) => Promise<UpdateAutomationSettingsHttpResponse>;
238
- type UpdateAutomationSettingsHttpResponse = {
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 UpdateAutomationSettingsHttpError = {
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 GetAutomationUsageMetricsHttpError
257
+ * @throws GetAutomationsUsageMetricsHttpError
253
258
  */
254
- declare const getAutomationUsageMetrics: (query: {
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<GetAutomationUsageMetricsHttpResponse>;
260
- type GetAutomationUsageMetricsHttpResponse = {
264
+ }, options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
265
+ type GetAutomationsUsageMetricsHttpResponse = {
261
266
  data: UsageList;
262
267
  headers: Headers;
263
268
  status: number;
264
269
  };
265
- type GetAutomationUsageMetricsHttpError = {
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
- * @throws GetAutomationSettingsHttpError
545
+ *
546
+ * @throws GetAutomationsSettingsHttpError
526
547
  */
527
- getAutomationSettings: typeof getAutomationSettings;
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 UpdateAutomationSettingsHttpError
553
+ * @throws UpdateAutomationsSettingsHttpError
532
554
  */
533
- updateAutomationSettings: typeof updateAutomationSettings;
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 GetAutomationUsageMetricsHttpError
561
+ * @throws GetAutomationsUsageMetricsHttpError
539
562
  */
540
- getAutomationUsageMetrics: typeof getAutomationUsageMetrics;
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 GetAutomationSettingsHttpError, type GetAutomationSettingsHttpResponse, type GetAutomationUsageMetricsHttpError, type GetAutomationUsageMetricsHttpResponse, type GetAutomationsHttpError, type GetAutomationsHttpResponse, 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 UpdateAutomationSettingsHttpError, type UpdateAutomationSettingsHttpResponse, type UsageList, type UsageObject, clearCache, copyAutomation, createAutomation, automationsExport as default, deleteAutomation, disableAutomation, enableAutomation, getAutomation, getAutomationRun, getAutomationRunDetails, getAutomationRuns, getAutomationSettings, getAutomationUsageMetrics, getAutomations, moveAutomation, queueAutomationRun, retryAutomationRun, stopAutomationRun, updateAutomation, updateAutomationSettings };
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 };