@kadoa/node-sdk 0.20.2 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -442,7 +442,7 @@ interface ClassificationFieldCategoriesInner {
442
442
  interface ClassificationField {
443
443
  [key: string]: any;
444
444
  /**
445
- * Field name (letters and numbers only)
445
+ * Field name in camelCase (e.g., category, productType)
446
446
  */
447
447
  'name': string;
448
448
  /**
@@ -494,7 +494,7 @@ type DataFieldExample = Array<string> | string;
494
494
  */
495
495
  interface DataField {
496
496
  /**
497
- * Field name (letters and numbers only)
497
+ * Field name in camelCase (e.g., productName, reviewCount)
498
498
  */
499
499
  'name': string;
500
500
  /**
@@ -504,14 +504,13 @@ interface DataField {
504
504
  'fieldType'?: DataFieldFieldTypeEnum;
505
505
  'example'?: DataFieldExample;
506
506
  /**
507
- * Data type of the field
507
+ * Data type of the field. Must be uppercase: STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY
508
508
  */
509
509
  'dataType': DataFieldDataTypeEnum;
510
510
  /**
511
511
  * Whether the field is a key field
512
512
  */
513
513
  'isKey'?: boolean;
514
- 'processing'?: DataFieldProcessingEnum;
515
514
  }
516
515
  declare const DataFieldFieldTypeEnum: {
517
516
  readonly Schema: "SCHEMA";
@@ -530,12 +529,6 @@ declare const DataFieldDataTypeEnum: {
530
529
  readonly Array: "ARRAY";
531
530
  };
532
531
  type DataFieldDataTypeEnum = typeof DataFieldDataTypeEnum[keyof typeof DataFieldDataTypeEnum];
533
- declare const DataFieldProcessingEnum: {
534
- readonly Unknown: "UNKNOWN";
535
- readonly Passthrough: "PASSTHROUGH";
536
- readonly Synthetic: "SYNTHETIC";
537
- };
538
- type DataFieldProcessingEnum = typeof DataFieldProcessingEnum[keyof typeof DataFieldProcessingEnum];
539
532
 
540
533
  /**
541
534
  * Kadoa API
@@ -554,7 +547,7 @@ type DataFieldProcessingEnum = typeof DataFieldProcessingEnum[keyof typeof DataF
554
547
  interface RawContentField {
555
548
  [key: string]: any;
556
549
  /**
557
- * Field name (letters and numbers only)
550
+ * Field name in camelCase (e.g., rawHtml, pageContent)
558
551
  */
559
552
  'name': string;
560
553
  /**
@@ -629,7 +622,7 @@ interface AgenticWorkflow {
629
622
  */
630
623
  'description'?: string;
631
624
  /**
632
- * Tags for organizing and categorizing workflows (minimum 3 characters per tag)
625
+ * Tags for organizing and categorizing workflows (minimum 2 characters per tag)
633
626
  */
634
627
  'tags'?: Array<string>;
635
628
  /**
@@ -682,6 +675,10 @@ interface AgenticWorkflow {
682
675
  * Regex patterns to exclude specific paths during crawling. Only used when navigationMode is \'all-pages\'
683
676
  */
684
677
  'pathsFilterOut'?: Array<string>;
678
+ /**
679
+ * PDF-specific: Array of page numbers to extract (1-indexed). If not provided, all pages are extracted. Example: [1, 5, 10]
680
+ */
681
+ 'pageNumbers'?: Array<number>;
685
682
  /**
686
683
  * Natural language instructions for the AI agent (10-5000 characters). Describe what data to extract and how to navigate the site
687
684
  */
@@ -1266,13 +1263,13 @@ interface CreateCrawlerConfigRequestNavigationOptions {
1266
1263
  * Ordered list of scripted browser actions executed after navigation
1267
1264
  */
1268
1265
  'browserActions'?: Array<{
1269
- [key: string]: any;
1266
+ [key: string]: any | null;
1270
1267
  }>;
1271
1268
  /**
1272
1269
  * Browser actions performed before the main action chain
1273
1270
  */
1274
1271
  'preBrowserActions'?: Array<{
1275
- [key: string]: any;
1272
+ [key: string]: any | null;
1276
1273
  }>;
1277
1274
  /**
1278
1275
  * Enable HTML capture while scrolling through the page
@@ -1310,7 +1307,7 @@ interface CreateCrawlerConfigRequestNavigationOptions {
1310
1307
  * Navigation exploration tuning payload
1311
1308
  */
1312
1309
  'navigationExploration'?: {
1313
- [key: string]: any;
1310
+ [key: string]: any | null;
1314
1311
  };
1315
1312
  /**
1316
1313
  * Skip scripted interactions and only capture HTML
@@ -1323,6 +1320,27 @@ interface CreateCrawlerConfigRequestNavigationOptions {
1323
1320
  'cachedCookieAccept'?: CreateCrawlerConfigRequestNavigationOptionsCachedCookieAccept;
1324
1321
  }
1325
1322
 
1323
+ /**
1324
+ * Kadoa API
1325
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1326
+ *
1327
+ * The version of the OpenAPI document: 3.0.0
1328
+ * Contact: support@kadoa.com
1329
+ *
1330
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1331
+ * https://openapi-generator.tech
1332
+ * Do not edit the class manually.
1333
+ */
1334
+ /**
1335
+ * Output options for raw mode
1336
+ */
1337
+ interface CreateCrawlerConfigRequestOutputOptions {
1338
+ 'includeHtml'?: boolean;
1339
+ 'includeMarkdown'?: boolean;
1340
+ 'includeScreenshots'?: boolean;
1341
+ 'includeJson'?: boolean;
1342
+ }
1343
+
1326
1344
  /**
1327
1345
  * Kadoa API
1328
1346
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1348,11 +1366,11 @@ interface CreateCrawlerConfigRequest {
1348
1366
  */
1349
1367
  'startUrls'?: Array<string>;
1350
1368
  /**
1351
- * Regex patterns to include specific paths
1369
+ * Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings.
1352
1370
  */
1353
1371
  'pathsFilterIn'?: Array<string>;
1354
1372
  /**
1355
- * Regex patterns to exclude specific paths
1373
+ * Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings.
1356
1374
  */
1357
1375
  'pathsFilterOut'?: Array<string>;
1358
1376
  /**
@@ -1415,6 +1433,23 @@ interface CreateCrawlerConfigRequest {
1415
1433
  'extractionOptions'?: CreateCrawlerConfigRequestExtractionOptions;
1416
1434
  'navigationOptions'?: CreateCrawlerConfigRequestNavigationOptions;
1417
1435
  'artifactOptions'?: CreateCrawlerConfigRequestArtifactOptions;
1436
+ /**
1437
+ * Whether this is a raw data mode crawl
1438
+ */
1439
+ 'rawMode'?: boolean;
1440
+ 'outputOptions'?: CreateCrawlerConfigRequestOutputOptions;
1441
+ /**
1442
+ * Internal: Job ID for workflow tracking
1443
+ */
1444
+ 'jobId'?: string;
1445
+ /**
1446
+ * Internal: Data key for Parquet storage path
1447
+ */
1448
+ 'dataKey'?: string;
1449
+ /**
1450
+ * Internal: Billing source identifier
1451
+ */
1452
+ 'billingSource'?: string;
1418
1453
  }
1419
1454
 
1420
1455
  /**
@@ -1442,11 +1477,11 @@ interface CreateCrawlerConfigResponse {
1442
1477
  */
1443
1478
  'startUrls'?: Array<string>;
1444
1479
  /**
1445
- * Regex patterns to include specific paths
1480
+ * Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings.
1446
1481
  */
1447
1482
  'pathsFilterIn'?: Array<string>;
1448
1483
  /**
1449
- * Regex patterns to exclude specific paths
1484
+ * Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings.
1450
1485
  */
1451
1486
  'pathsFilterOut'?: Array<string>;
1452
1487
  /**
@@ -1509,6 +1544,23 @@ interface CreateCrawlerConfigResponse {
1509
1544
  'extractionOptions'?: CreateCrawlerConfigRequestExtractionOptions;
1510
1545
  'navigationOptions'?: CreateCrawlerConfigRequestNavigationOptions;
1511
1546
  'artifactOptions'?: CreateCrawlerConfigRequestArtifactOptions;
1547
+ /**
1548
+ * Whether this is a raw data mode crawl
1549
+ */
1550
+ 'rawMode'?: boolean;
1551
+ 'outputOptions'?: CreateCrawlerConfigRequestOutputOptions;
1552
+ /**
1553
+ * Internal: Job ID for workflow tracking
1554
+ */
1555
+ 'jobId'?: string;
1556
+ /**
1557
+ * Internal: Data key for Parquet storage path
1558
+ */
1559
+ 'dataKey'?: string;
1560
+ /**
1561
+ * Internal: Billing source identifier
1562
+ */
1563
+ 'billingSource'?: string;
1512
1564
  /**
1513
1565
  * Config ID
1514
1566
  */
@@ -1534,9 +1586,23 @@ interface CreateCrawlerConfigResponse {
1534
1586
  * https://openapi-generator.tech
1535
1587
  * Do not edit the class manually.
1536
1588
  */
1537
- interface CreateRuleParameters {
1538
- 'sql'?: string;
1539
- 'params'?: Array<any | null>;
1589
+
1590
+ /**
1591
+ * Request body for creating a new schema
1592
+ */
1593
+ interface CreateSchemaBody {
1594
+ /**
1595
+ * Name of the schema
1596
+ */
1597
+ 'name': string;
1598
+ /**
1599
+ * Entity type for the schema
1600
+ */
1601
+ 'entity'?: string;
1602
+ /**
1603
+ * Schema fields for extraction - choose from Data Field (typed data), Raw Content Field (HTML/Markdown), or Classification Field (predefined categories)
1604
+ */
1605
+ 'fields': Array<SchemaResponseSchemaInner>;
1540
1606
  }
1541
1607
 
1542
1608
  /**
@@ -1550,32 +1616,35 @@ interface CreateRuleParameters {
1550
1616
  * https://openapi-generator.tech
1551
1617
  * Do not edit the class manually.
1552
1618
  */
1553
-
1554
1619
  /**
1555
- * Request body for creating a new validation rule
1620
+ * Response for schema creation
1556
1621
  */
1557
- interface CreateRule {
1558
- 'name': string;
1559
- 'description'?: string;
1560
- 'ruleType': CreateRuleRuleTypeEnum;
1561
- 'workflowId'?: string;
1562
- 'targetColumns'?: Array<string>;
1563
- 'parameters': CreateRuleParameters;
1564
- 'status'?: CreateRuleStatusEnum;
1565
- 'metadata'?: {
1566
- [key: string]: any | null;
1567
- };
1622
+ interface CreateSchemaResponse {
1623
+ /**
1624
+ * Error flag (always false on success)
1625
+ */
1626
+ 'error': boolean;
1627
+ /**
1628
+ * Success flag
1629
+ */
1630
+ 'success': boolean;
1631
+ /**
1632
+ * ID of the created schema
1633
+ */
1634
+ 'schemaId': string;
1635
+ /**
1636
+ * Success message
1637
+ */
1638
+ 'message': string;
1639
+ /**
1640
+ * Creation timestamp
1641
+ */
1642
+ 'createdAt'?: string;
1643
+ /**
1644
+ * Last update timestamp
1645
+ */
1646
+ 'updatedAt'?: string;
1568
1647
  }
1569
- declare const CreateRuleRuleTypeEnum: {
1570
- readonly CustomSql: "custom_sql";
1571
- };
1572
- type CreateRuleRuleTypeEnum = typeof CreateRuleRuleTypeEnum[keyof typeof CreateRuleRuleTypeEnum];
1573
- declare const CreateRuleStatusEnum: {
1574
- readonly Preview: "preview";
1575
- readonly Enabled: "enabled";
1576
- readonly Disabled: "disabled";
1577
- };
1578
- type CreateRuleStatusEnum = typeof CreateRuleStatusEnum[keyof typeof CreateRuleStatusEnum];
1579
1648
 
1580
1649
  /**
1581
1650
  * Kadoa API
@@ -1588,23 +1657,26 @@ type CreateRuleStatusEnum = typeof CreateRuleStatusEnum[keyof typeof CreateRuleS
1588
1657
  * https://openapi-generator.tech
1589
1658
  * Do not edit the class manually.
1590
1659
  */
1591
-
1592
1660
  /**
1593
- * Request body for creating a new schema
1661
+ * Which artifacts to include in output
1594
1662
  */
1595
- interface CreateSchemaBody {
1663
+ interface RawDataWorkflowOutputOptions {
1596
1664
  /**
1597
- * Name of the schema
1665
+ * Include raw HTML content
1598
1666
  */
1599
- 'name': string;
1667
+ 'includeHtml'?: boolean;
1600
1668
  /**
1601
- * Entity type for the schema
1669
+ * Include Markdown conversion
1602
1670
  */
1603
- 'entity'?: string;
1671
+ 'includeMarkdown'?: boolean;
1604
1672
  /**
1605
- * Schema fields for extraction - choose from Data Field (typed data), Raw Content Field (HTML/Markdown), or Classification Field (predefined categories)
1673
+ * Include screenshots as Base64
1606
1674
  */
1607
- 'fields': Array<SchemaResponseSchemaInner>;
1675
+ 'includeScreenshots'?: boolean;
1676
+ /**
1677
+ * Include JSON extraction results
1678
+ */
1679
+ 'includeJson'?: boolean;
1608
1680
  }
1609
1681
 
1610
1682
  /**
@@ -1618,35 +1690,78 @@ interface CreateSchemaBody {
1618
1690
  * https://openapi-generator.tech
1619
1691
  * Do not edit the class manually.
1620
1692
  */
1693
+
1621
1694
  /**
1622
- * Response for schema creation
1695
+ * Create a raw data workflow that crawls pages and returns artifacts (HTML, Markdown, Screenshots) without schema extraction. Example: `{\"urls\": [\"https://example.com\"], \"outputOptions\": {\"includeHtml\": true, \"includeMarkdown\": true}}`
1623
1696
  */
1624
- interface CreateSchemaResponse {
1697
+ interface RawDataWorkflow {
1625
1698
  /**
1626
- * Error flag (always false on success)
1699
+ * URLs to crawl
1627
1700
  */
1628
- 'error': boolean;
1701
+ 'urls': Array<string>;
1629
1702
  /**
1630
- * Success flag
1703
+ * Workflow name
1631
1704
  */
1632
- 'success': boolean;
1705
+ 'name'?: string;
1633
1706
  /**
1634
- * ID of the created schema
1707
+ * Workflow description
1635
1708
  */
1636
- 'schemaId': string;
1709
+ 'description'?: string;
1637
1710
  /**
1638
- * Success message
1711
+ * Tags for organization (minimum 2 characters per tag)
1639
1712
  */
1640
- 'message': string;
1713
+ 'tags'?: Array<string>;
1714
+ 'outputOptions': RawDataWorkflowOutputOptions;
1641
1715
  /**
1642
- * Creation timestamp
1716
+ * Maximum pages to crawl (default: 10,000, max: 100,000)
1643
1717
  */
1644
- 'createdAt'?: string;
1718
+ 'maxPages'?: number;
1645
1719
  /**
1646
- * Last update timestamp
1720
+ * Maximum crawl depth (default: 50, max: 200)
1647
1721
  */
1648
- 'updatedAt'?: string;
1722
+ 'maxDepth'?: number;
1723
+ /**
1724
+ * Regex patterns to include specific paths
1725
+ */
1726
+ 'pathsFilterIn'?: Array<string>;
1727
+ /**
1728
+ * Regex patterns to exclude specific paths
1729
+ */
1730
+ 'pathsFilterOut'?: Array<string>;
1731
+ /**
1732
+ * Update frequency for the workflow
1733
+ */
1734
+ 'interval'?: RawDataWorkflowIntervalEnum;
1735
+ /**
1736
+ * Cron expressions for custom schedules
1737
+ */
1738
+ 'schedules'?: Array<string>;
1739
+ /**
1740
+ * Auto-start workflow after creation
1741
+ */
1742
+ 'autoStart'?: boolean;
1649
1743
  }
1744
+ declare const RawDataWorkflowIntervalEnum: {
1745
+ readonly OnlyOnce: "ONLY_ONCE";
1746
+ readonly Every10Minutes: "EVERY_10_MINUTES";
1747
+ readonly HalfHourly: "HALF_HOURLY";
1748
+ readonly Hourly: "HOURLY";
1749
+ readonly ThreeHourly: "THREE_HOURLY";
1750
+ readonly SixHourly: "SIX_HOURLY";
1751
+ readonly TwelveHourly: "TWELVE_HOURLY";
1752
+ readonly EighteenHourly: "EIGHTEEN_HOURLY";
1753
+ readonly Daily: "DAILY";
1754
+ readonly TwoDay: "TWO_DAY";
1755
+ readonly ThreeDay: "THREE_DAY";
1756
+ readonly Weekly: "WEEKLY";
1757
+ readonly Biweekly: "BIWEEKLY";
1758
+ readonly Triweekly: "TRIWEEKLY";
1759
+ readonly FourWeeks: "FOUR_WEEKS";
1760
+ readonly Monthly: "MONTHLY";
1761
+ readonly RealTime: "REAL_TIME";
1762
+ readonly Custom: "CUSTOM";
1763
+ };
1764
+ type RawDataWorkflowIntervalEnum = typeof RawDataWorkflowIntervalEnum[keyof typeof RawDataWorkflowIntervalEnum];
1650
1765
 
1651
1766
  /**
1652
1767
  * Kadoa API
@@ -1681,7 +1796,7 @@ interface WorkflowWithEntityAndFields {
1681
1796
  */
1682
1797
  'description'?: string;
1683
1798
  /**
1684
- * Tags for organizing and categorizing workflows (minimum 3 characters per tag)
1799
+ * Tags for organizing and categorizing workflows (minimum 2 characters per tag)
1685
1800
  */
1686
1801
  'tags'?: Array<string>;
1687
1802
  /**
@@ -1735,9 +1850,13 @@ interface WorkflowWithEntityAndFields {
1735
1850
  */
1736
1851
  'pathsFilterOut'?: Array<string>;
1737
1852
  /**
1738
- * Entity name for extraction. Required when schema contains structured data fields (SCHEMA type)
1853
+ * PDF-specific: Array of page numbers to extract (1-indexed). If not provided, all pages are extracted. Example: [1, 5, 10]
1739
1854
  */
1740
- 'entity'?: string;
1855
+ 'pageNumbers'?: Array<number>;
1856
+ /**
1857
+ * Entity name for extraction (e.g., \'Product\', \'JobListing\')
1858
+ */
1859
+ 'entity': string;
1741
1860
  /**
1742
1861
  * Array of fields to extract from each item. Each field defines a property to capture (e.g., title, price, description)
1743
1862
  */
@@ -1806,7 +1925,7 @@ interface WorkflowWithExistingSchema {
1806
1925
  */
1807
1926
  'description'?: string;
1808
1927
  /**
1809
- * Tags for organizing and categorizing workflows (minimum 3 characters per tag)
1928
+ * Tags for organizing and categorizing workflows (minimum 2 characters per tag)
1810
1929
  */
1811
1930
  'tags'?: Array<string>;
1812
1931
  /**
@@ -1859,6 +1978,10 @@ interface WorkflowWithExistingSchema {
1859
1978
  * Regex patterns to exclude specific paths during crawling. Only used when navigationMode is \'all-pages\'
1860
1979
  */
1861
1980
  'pathsFilterOut'?: Array<string>;
1981
+ /**
1982
+ * PDF-specific: Array of page numbers to extract (1-indexed). If not provided, all pages are extracted. Example: [1, 5, 10]
1983
+ */
1984
+ 'pageNumbers'?: Array<number>;
1862
1985
  /**
1863
1986
  * ID of an existing schema configuration. Use this to reference a previously defined schema without re-defining extraction fields
1864
1987
  */
@@ -1910,7 +2033,7 @@ type WorkflowWithExistingSchemaIntervalEnum = typeof WorkflowWithExistingSchemaI
1910
2033
  * @type CreateWorkflowBody
1911
2034
  * Request body for creating a new workflow
1912
2035
  */
1913
- type CreateWorkflowBody = AgenticWorkflow | WorkflowWithEntityAndFields | WorkflowWithExistingSchema;
2036
+ type CreateWorkflowBody = AgenticWorkflow | RawDataWorkflow | WorkflowWithEntityAndFields | WorkflowWithExistingSchema;
1914
2037
 
1915
2038
  /**
1916
2039
  * Kadoa API
@@ -2352,6 +2475,10 @@ type DataValidationReportStrategyEnum = typeof DataValidationReportStrategyEnum[
2352
2475
  * Request body for scheduling validation with custom rules and options
2353
2476
  */
2354
2477
  interface DataValidationRequestBody {
2478
+ /**
2479
+ * Client-provided validation ID for idempotency. If omitted, server generates one.
2480
+ */
2481
+ 'validationId'?: string;
2355
2482
  'customRules'?: Array<DynamicRuleConfig>;
2356
2483
  /**
2357
2484
  * Optional LLM prompt used to generate or explain rules
@@ -2710,6 +2837,7 @@ interface GenerateRules {
2710
2837
  'maxRules'?: number;
2711
2838
  'workflowId': string;
2712
2839
  'isPreviewRun'?: boolean;
2840
+ 'autoEnable'?: boolean;
2713
2841
  'prompt'?: string;
2714
2842
  }
2715
2843
 
@@ -2760,11 +2888,11 @@ interface GetCrawlerConfigResponse {
2760
2888
  */
2761
2889
  'startUrls'?: Array<string>;
2762
2890
  /**
2763
- * Regex patterns to include specific paths
2891
+ * Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings.
2764
2892
  */
2765
2893
  'pathsFilterIn'?: Array<string>;
2766
2894
  /**
2767
- * Regex patterns to exclude specific paths
2895
+ * Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings.
2768
2896
  */
2769
2897
  'pathsFilterOut'?: Array<string>;
2770
2898
  /**
@@ -2827,6 +2955,23 @@ interface GetCrawlerConfigResponse {
2827
2955
  'extractionOptions'?: CreateCrawlerConfigRequestExtractionOptions;
2828
2956
  'navigationOptions'?: CreateCrawlerConfigRequestNavigationOptions;
2829
2957
  'artifactOptions'?: CreateCrawlerConfigRequestArtifactOptions;
2958
+ /**
2959
+ * Whether this is a raw data mode crawl
2960
+ */
2961
+ 'rawMode'?: boolean;
2962
+ 'outputOptions'?: CreateCrawlerConfigRequestOutputOptions;
2963
+ /**
2964
+ * Internal: Job ID for workflow tracking
2965
+ */
2966
+ 'jobId'?: string;
2967
+ /**
2968
+ * Internal: Data key for Parquet storage path
2969
+ */
2970
+ 'dataKey'?: string;
2971
+ /**
2972
+ * Internal: Billing source identifier
2973
+ */
2974
+ 'billingSource'?: string;
2830
2975
  /**
2831
2976
  * Config ID
2832
2977
  */
@@ -3350,27 +3495,6 @@ interface ResumeCrawlerSessionResponse {
3350
3495
  'error': string | null;
3351
3496
  }
3352
3497
 
3353
- /**
3354
- * Kadoa API
3355
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3356
- *
3357
- * The version of the OpenAPI document: 3.0.0
3358
- * Contact: support@kadoa.com
3359
- *
3360
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3361
- * https://openapi-generator.tech
3362
- * Do not edit the class manually.
3363
- */
3364
-
3365
- /**
3366
- * Confirmation after successful rule creation
3367
- */
3368
- interface RuleCreateResponse {
3369
- 'error': boolean;
3370
- 'message': string;
3371
- 'data': Rule$1;
3372
- }
3373
-
3374
3498
  /**
3375
3499
  * Kadoa API
3376
3500
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3431,27 +3555,6 @@ interface RuleResponse {
3431
3555
  'data': Rule$1;
3432
3556
  }
3433
3557
 
3434
- /**
3435
- * Kadoa API
3436
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3437
- *
3438
- * The version of the OpenAPI document: 3.0.0
3439
- * Contact: support@kadoa.com
3440
- *
3441
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3442
- * https://openapi-generator.tech
3443
- * Do not edit the class manually.
3444
- */
3445
-
3446
- /**
3447
- * Updated rule details after modification
3448
- */
3449
- interface RuleUpdateResponse {
3450
- 'error': boolean;
3451
- 'message': string;
3452
- 'data': Rule$1;
3453
- }
3454
-
3455
3558
  /**
3456
3559
  * Kadoa API
3457
3560
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3501,6 +3604,10 @@ interface ScheduleValidationResponse {
3501
3604
  'customRulesCount': number;
3502
3605
  'totalRulesCount': number;
3503
3606
  'createdAt': string;
3607
+ /**
3608
+ * True if validation with this ID already exists (idempotency)
3609
+ */
3610
+ 'existed': boolean;
3504
3611
  }
3505
3612
 
3506
3613
  /**
@@ -3702,11 +3809,11 @@ interface StartCrawlerSessionRequest {
3702
3809
  */
3703
3810
  'startUrls'?: Array<string>;
3704
3811
  /**
3705
- * Regex patterns to include specific paths
3812
+ * Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings.
3706
3813
  */
3707
3814
  'pathsFilterIn'?: Array<string>;
3708
3815
  /**
3709
- * Regex patterns to exclude specific paths
3816
+ * Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings.
3710
3817
  */
3711
3818
  'pathsFilterOut'?: Array<string>;
3712
3819
  /**
@@ -3769,6 +3876,23 @@ interface StartCrawlerSessionRequest {
3769
3876
  'extractionOptions'?: CreateCrawlerConfigRequestExtractionOptions;
3770
3877
  'navigationOptions'?: CreateCrawlerConfigRequestNavigationOptions;
3771
3878
  'artifactOptions'?: CreateCrawlerConfigRequestArtifactOptions;
3879
+ /**
3880
+ * Whether this is a raw data mode crawl
3881
+ */
3882
+ 'rawMode'?: boolean;
3883
+ 'outputOptions'?: CreateCrawlerConfigRequestOutputOptions;
3884
+ /**
3885
+ * Internal: Job ID for workflow tracking
3886
+ */
3887
+ 'jobId'?: string;
3888
+ /**
3889
+ * Internal: Data key for Parquet storage path
3890
+ */
3891
+ 'dataKey'?: string;
3892
+ /**
3893
+ * Internal: Billing source identifier
3894
+ */
3895
+ 'billingSource'?: string;
3772
3896
  }
3773
3897
 
3774
3898
  /**
@@ -3825,39 +3949,6 @@ interface StartSessionWithConfigRequest {
3825
3949
  'configId': string;
3826
3950
  }
3827
3951
 
3828
- /**
3829
- * Kadoa API
3830
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3831
- *
3832
- * The version of the OpenAPI document: 3.0.0
3833
- * Contact: support@kadoa.com
3834
- *
3835
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3836
- * https://openapi-generator.tech
3837
- * Do not edit the class manually.
3838
- */
3839
-
3840
- /**
3841
- * Partial update request for modifying validation rules
3842
- */
3843
- interface UpdateRule {
3844
- 'name'?: string;
3845
- 'description'?: string;
3846
- 'targetColumns'?: Array<string>;
3847
- 'parameters'?: CreateRuleParameters;
3848
- 'status'?: UpdateRuleStatusEnum;
3849
- 'disabledReason'?: string | null;
3850
- 'metadata'?: {
3851
- [key: string]: any | null;
3852
- };
3853
- }
3854
- declare const UpdateRuleStatusEnum: {
3855
- readonly Preview: "preview";
3856
- readonly Enabled: "enabled";
3857
- readonly Disabled: "disabled";
3858
- };
3859
- type UpdateRuleStatusEnum = typeof UpdateRuleStatusEnum[keyof typeof UpdateRuleStatusEnum];
3860
-
3861
3952
  /**
3862
3953
  * Kadoa API
3863
3954
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4069,21 +4160,126 @@ interface V4ChangesGet200ResponseChangesInner {
4069
4160
  */
4070
4161
  interface V4ChangesGet200ResponsePagination {
4071
4162
  /**
4072
- * Total number of changes found
4163
+ * Total number of changes found
4164
+ */
4165
+ 'totalCount'?: number;
4166
+ /**
4167
+ * Current page number
4168
+ */
4169
+ 'page'?: number;
4170
+ /**
4171
+ * Total number of pages
4172
+ */
4173
+ 'totalPages'?: number;
4174
+ /**
4175
+ * Number of records per page
4176
+ */
4177
+ 'limit'?: number;
4178
+ }
4179
+
4180
+ /**
4181
+ * Kadoa API
4182
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4183
+ *
4184
+ * The version of the OpenAPI document: 3.0.0
4185
+ * Contact: support@kadoa.com
4186
+ *
4187
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4188
+ * https://openapi-generator.tech
4189
+ * Do not edit the class manually.
4190
+ */
4191
+
4192
+ interface V4ChangesGet200Response {
4193
+ /**
4194
+ * Timestamp of the response
4195
+ */
4196
+ 'timestamp'?: string;
4197
+ /**
4198
+ * Total number of changes found
4199
+ */
4200
+ 'changesCount'?: number;
4201
+ 'changes'?: Array<V4ChangesGet200ResponseChangesInner>;
4202
+ 'pagination'?: V4ChangesGet200ResponsePagination;
4203
+ }
4204
+
4205
+ /**
4206
+ * Kadoa API
4207
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4208
+ *
4209
+ * The version of the OpenAPI document: 3.0.0
4210
+ * Contact: support@kadoa.com
4211
+ *
4212
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4213
+ * https://openapi-generator.tech
4214
+ * Do not edit the class manually.
4215
+ */
4216
+ /**
4217
+ * @type V4DataValidationRulesGetIncludeDeletedParameter
4218
+ */
4219
+ type V4DataValidationRulesGetIncludeDeletedParameter = boolean | string;
4220
+
4221
+ /**
4222
+ * Kadoa API
4223
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4224
+ *
4225
+ * The version of the OpenAPI document: 3.0.0
4226
+ * Contact: support@kadoa.com
4227
+ *
4228
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4229
+ * https://openapi-generator.tech
4230
+ * Do not edit the class manually.
4231
+ */
4232
+
4233
+ interface V4DataValidationWorkflowsWorkflowIdValidationConfigGet200Response {
4234
+ 'workflowId': string;
4235
+ 'dataValidation'?: DataValidationConfig;
4236
+ 'error': boolean;
4237
+ }
4238
+
4239
+ /**
4240
+ * Kadoa API
4241
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4242
+ *
4243
+ * The version of the OpenAPI document: 3.0.0
4244
+ * Contact: support@kadoa.com
4245
+ *
4246
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4247
+ * https://openapi-generator.tech
4248
+ * Do not edit the class manually.
4249
+ */
4250
+
4251
+ interface V4DataValidationWorkflowsWorkflowIdValidationConfigPutRequest {
4252
+ 'dataValidation'?: DataValidationConfig1;
4253
+ }
4254
+
4255
+ /**
4256
+ * Kadoa API
4257
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4258
+ *
4259
+ * The version of the OpenAPI document: 3.0.0
4260
+ * Contact: support@kadoa.com
4261
+ *
4262
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4263
+ * https://openapi-generator.tech
4264
+ * Do not edit the class manually.
4265
+ */
4266
+ interface V4DataValidationWorkflowsWorkflowIdValidationTogglePut200Response {
4267
+ /**
4268
+ * Whether an error occurred
4073
4269
  */
4074
- 'totalCount'?: number;
4270
+ 'error': boolean;
4075
4271
  /**
4076
- * Current page number
4272
+ * Success message indicating the action performed
4077
4273
  */
4078
- 'page'?: number;
4274
+ 'message': string;
4079
4275
  /**
4080
- * Total number of pages
4276
+ * The workflow ID that was updated
4081
4277
  */
4082
- 'totalPages'?: number;
4278
+ 'workflowId': string;
4083
4279
  /**
4084
- * Number of records per page
4280
+ * The new validation status for the workflow
4085
4281
  */
4086
- 'limit'?: number;
4282
+ 'enabled': boolean;
4087
4283
  }
4088
4284
 
4089
4285
  /**
@@ -4097,18 +4293,11 @@ interface V4ChangesGet200ResponsePagination {
4097
4293
  * https://openapi-generator.tech
4098
4294
  * Do not edit the class manually.
4099
4295
  */
4100
-
4101
- interface V4ChangesGet200Response {
4102
- /**
4103
- * Timestamp of the response
4104
- */
4105
- 'timestamp'?: string;
4296
+ interface V4DataValidationWorkflowsWorkflowIdValidationTogglePutRequest {
4106
4297
  /**
4107
- * Total number of changes found
4298
+ * Whether to enable or disable data validation for the workflow
4108
4299
  */
4109
- 'changesCount'?: number;
4110
- 'changes'?: Array<V4ChangesGet200ResponseChangesInner>;
4111
- 'pagination'?: V4ChangesGet200ResponsePagination;
4300
+ 'enabled': boolean;
4112
4301
  }
4113
4302
 
4114
4303
  /**
@@ -4122,10 +4311,18 @@ interface V4ChangesGet200Response {
4122
4311
  * https://openapi-generator.tech
4123
4312
  * Do not edit the class manually.
4124
4313
  */
4125
- /**
4126
- * @type V4DataValidationRulesGetIncludeDeletedParameter
4127
- */
4128
- type V4DataValidationRulesGetIncludeDeletedParameter = boolean | string;
4314
+ interface V4WorkflowsBulkPost200ResponseResultsInner {
4315
+ 'workflowId'?: string;
4316
+ 'success'?: boolean;
4317
+ /**
4318
+ * Error message if success is false
4319
+ */
4320
+ 'error'?: string;
4321
+ /**
4322
+ * Job ID (for run action only)
4323
+ */
4324
+ 'jobId'?: string;
4325
+ }
4129
4326
 
4130
4327
  /**
4131
4328
  * Kadoa API
@@ -4138,11 +4335,10 @@ type V4DataValidationRulesGetIncludeDeletedParameter = boolean | string;
4138
4335
  * https://openapi-generator.tech
4139
4336
  * Do not edit the class manually.
4140
4337
  */
4141
-
4142
- interface V4DataValidationWorkflowsWorkflowIdValidationConfigGet200Response {
4143
- 'workflowId': string;
4144
- 'dataValidation'?: DataValidationConfig;
4145
- 'error': boolean;
4338
+ interface V4WorkflowsBulkPost200ResponseSummary {
4339
+ 'total'?: number;
4340
+ 'succeeded'?: number;
4341
+ 'failed'?: number;
4146
4342
  }
4147
4343
 
4148
4344
  /**
@@ -4157,8 +4353,9 @@ interface V4DataValidationWorkflowsWorkflowIdValidationConfigGet200Response {
4157
4353
  * Do not edit the class manually.
4158
4354
  */
4159
4355
 
4160
- interface V4DataValidationWorkflowsWorkflowIdValidationConfigPutRequest {
4161
- 'dataValidation'?: DataValidationConfig1;
4356
+ interface V4WorkflowsBulkPost200Response {
4357
+ 'results'?: Array<V4WorkflowsBulkPost200ResponseResultsInner>;
4358
+ 'summary'?: V4WorkflowsBulkPost200ResponseSummary;
4162
4359
  }
4163
4360
 
4164
4361
  /**
@@ -4172,23 +4369,14 @@ interface V4DataValidationWorkflowsWorkflowIdValidationConfigPutRequest {
4172
4369
  * https://openapi-generator.tech
4173
4370
  * Do not edit the class manually.
4174
4371
  */
4175
- interface V4DataValidationWorkflowsWorkflowIdValidationTogglePut200Response {
4176
- /**
4177
- * Whether an error occurred
4178
- */
4179
- 'error': boolean;
4180
- /**
4181
- * Success message indicating the action performed
4182
- */
4183
- 'message': string;
4184
- /**
4185
- * The workflow ID that was updated
4186
- */
4187
- 'workflowId': string;
4372
+ /**
4373
+ * Action-specific parameters
4374
+ */
4375
+ interface V4WorkflowsBulkPostRequestParams {
4188
4376
  /**
4189
- * The new validation status for the workflow
4377
+ * Tags to assign (required for assignTags action)
4190
4378
  */
4191
- 'enabled': boolean;
4379
+ 'tags'?: Array<string>;
4192
4380
  }
4193
4381
 
4194
4382
  /**
@@ -4202,12 +4390,27 @@ interface V4DataValidationWorkflowsWorkflowIdValidationTogglePut200Response {
4202
4390
  * https://openapi-generator.tech
4203
4391
  * Do not edit the class manually.
4204
4392
  */
4205
- interface V4DataValidationWorkflowsWorkflowIdValidationTogglePutRequest {
4393
+
4394
+ interface V4WorkflowsBulkPostRequest {
4206
4395
  /**
4207
- * Whether to enable or disable data validation for the workflow
4396
+ * Array of workflow IDs to operate on (max 50)
4208
4397
  */
4209
- 'enabled': boolean;
4398
+ 'workflowIds': Array<string>;
4399
+ /**
4400
+ * The action to perform on all workflows
4401
+ */
4402
+ 'action': V4WorkflowsBulkPostRequestActionEnum;
4403
+ 'params'?: V4WorkflowsBulkPostRequestParams;
4210
4404
  }
4405
+ declare const V4WorkflowsBulkPostRequestActionEnum: {
4406
+ readonly Run: "run";
4407
+ readonly Pause: "pause";
4408
+ readonly Resume: "resume";
4409
+ readonly Delete: "delete";
4410
+ readonly Approve: "approve";
4411
+ readonly AssignTags: "assignTags";
4412
+ };
4413
+ type V4WorkflowsBulkPostRequestActionEnum = typeof V4WorkflowsBulkPostRequestActionEnum[keyof typeof V4WorkflowsBulkPostRequestActionEnum];
4211
4414
 
4212
4415
  /**
4213
4416
  * Kadoa API
@@ -4429,6 +4632,69 @@ interface V4WorkflowsWorkflowIdGet200ResponseNotificationConfig {
4429
4632
  'fields'?: Array<V4WorkflowsWorkflowIdGet200ResponseNotificationConfigFieldsInner>;
4430
4633
  }
4431
4634
 
4635
+ /**
4636
+ * Kadoa API
4637
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4638
+ *
4639
+ * The version of the OpenAPI document: 3.0.0
4640
+ * Contact: support@kadoa.com
4641
+ *
4642
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4643
+ * https://openapi-generator.tech
4644
+ * Do not edit the class manually.
4645
+ */
4646
+ /**
4647
+ * Health status for REAL_TIME observer workflows. Only present when health monitoring is active and detects issues.
4648
+ */
4649
+ interface V4WorkflowsWorkflowIdGet200ResponseObserverHealth {
4650
+ /**
4651
+ * Current health tier
4652
+ */
4653
+ 'healthTier'?: V4WorkflowsWorkflowIdGet200ResponseObserverHealthHealthTierEnum;
4654
+ /**
4655
+ * Human-readable explanation of the health status
4656
+ */
4657
+ 'reason'?: string;
4658
+ /**
4659
+ * When the current degradation episode started
4660
+ */
4661
+ 'issueStartedAt'?: string;
4662
+ /**
4663
+ * When health was last evaluated
4664
+ */
4665
+ 'lastCheckedAt'?: string;
4666
+ }
4667
+ declare const V4WorkflowsWorkflowIdGet200ResponseObserverHealthHealthTierEnum: {
4668
+ readonly Healthy: "HEALTHY";
4669
+ readonly Warning: "WARNING";
4670
+ readonly Degraded: "DEGRADED";
4671
+ readonly Unhealthy: "UNHEALTHY";
4672
+ readonly Failed: "FAILED";
4673
+ };
4674
+ type V4WorkflowsWorkflowIdGet200ResponseObserverHealthHealthTierEnum = typeof V4WorkflowsWorkflowIdGet200ResponseObserverHealthHealthTierEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseObserverHealthHealthTierEnum];
4675
+
4676
+ /**
4677
+ * Kadoa API
4678
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4679
+ *
4680
+ * The version of the OpenAPI document: 3.0.0
4681
+ * Contact: support@kadoa.com
4682
+ *
4683
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4684
+ * https://openapi-generator.tech
4685
+ * Do not edit the class manually.
4686
+ */
4687
+ interface V4WorkflowsWorkflowIdGet200ResponseOpenSupportRequestsInner {
4688
+ /**
4689
+ * Linear issue identifier (e.g., KAD-123)
4690
+ */
4691
+ 'issueId'?: string | null;
4692
+ /**
4693
+ * When the support request was created
4694
+ */
4695
+ 'requestedAt'?: string;
4696
+ }
4697
+
4432
4698
  /**
4433
4699
  * Kadoa API
4434
4700
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4560,13 +4826,17 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
4560
4826
  */
4561
4827
  'description'?: string;
4562
4828
  /**
4563
- * Current state of the workflow
4829
+ * Persisted workflow lifecycle state. ACTIVE = workflow is enabled, PAUSED = user paused it, DELETED = soft deleted. Use inSupport param to filter by support status.
4564
4830
  */
4565
4831
  'state'?: V4WorkflowsGet200ResponseWorkflowsInnerStateEnum;
4566
4832
  /**
4567
- * Display state for frontend
4833
+ * Computed status shown to users. Combines state + runState. ACTIVE = complete/scheduled, FAILED = last run failed, RUNNING = job in progress. Use this for dashboard filtering.
4568
4834
  */
4569
4835
  'displayState'?: V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum;
4836
+ /**
4837
+ * List of open support requests for this workflow. Only present when there are open requests.
4838
+ */
4839
+ 'openSupportRequests'?: Array<V4WorkflowsWorkflowIdGet200ResponseOpenSupportRequestsInner>;
4570
4840
  /**
4571
4841
  * ID of the user who owns the workflow
4572
4842
  */
@@ -4605,9 +4875,9 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
4605
4875
  */
4606
4876
  'runCosts'?: number;
4607
4877
  /**
4608
- * State of the last job run
4878
+ * Latest job execution state. RUNNING = job in progress, FINISHED = job completed successfully, FAILED = job failed. This is the raw job state before computing displayState.
4609
4879
  */
4610
- 'runState'?: string;
4880
+ 'runState'?: V4WorkflowsGet200ResponseWorkflowsInnerRunStateEnum;
4611
4881
  /**
4612
4882
  * Total number of records extracted
4613
4883
  */
@@ -4659,6 +4929,7 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
4659
4929
  */
4660
4930
  'monitoring'?: boolean;
4661
4931
  'notificationConfig'?: V4WorkflowsWorkflowIdGet200ResponseNotificationConfig;
4932
+ 'observerHealth'?: V4WorkflowsWorkflowIdGet200ResponseObserverHealth | null;
4662
4933
  }
4663
4934
  declare const V4WorkflowsGet200ResponseWorkflowsInnerStateEnum: {
4664
4935
  readonly Active: "ACTIVE";
@@ -4679,16 +4950,22 @@ declare const V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum: {
4679
4950
  readonly Paused: "PAUSED";
4680
4951
  readonly NotSupported: "NOT_SUPPORTED";
4681
4952
  readonly Preview: "PREVIEW";
4682
- readonly ComplianceReview: "COMPLIANCE_REVIEW";
4683
- readonly ComplianceRejected: "COMPLIANCE_REJECTED";
4684
4953
  readonly Queued: "QUEUED";
4685
4954
  readonly Setup: "SETUP";
4686
4955
  readonly PendingStart: "PENDING_START";
4687
4956
  readonly Running: "RUNNING";
4688
4957
  readonly Failed: "FAILED";
4958
+ readonly ComplianceReview: "COMPLIANCE_REVIEW";
4959
+ readonly ComplianceRejected: "COMPLIANCE_REJECTED";
4689
4960
  readonly Deleted: "DELETED";
4690
4961
  };
4691
4962
  type V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum = typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum[keyof typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum];
4963
+ declare const V4WorkflowsGet200ResponseWorkflowsInnerRunStateEnum: {
4964
+ readonly Running: "RUNNING";
4965
+ readonly Finished: "FINISHED";
4966
+ readonly Failed: "FAILED";
4967
+ };
4968
+ type V4WorkflowsGet200ResponseWorkflowsInnerRunStateEnum = typeof V4WorkflowsGet200ResponseWorkflowsInnerRunStateEnum[keyof typeof V4WorkflowsGet200ResponseWorkflowsInnerRunStateEnum];
4692
4969
  declare const V4WorkflowsGet200ResponseWorkflowsInnerNavigationModeEnum: {
4693
4970
  readonly SinglePage: "single-page";
4694
4971
  readonly PaginatedPage: "paginated-page";
@@ -5066,11 +5343,11 @@ interface V4WorkflowsWorkflowIdGet200Response {
5066
5343
  */
5067
5344
  'description'?: string;
5068
5345
  /**
5069
- * Current state of the workflow
5346
+ * Persisted workflow lifecycle state. ACTIVE = workflow is enabled, PAUSED = user paused it, DELETED = soft deleted.
5070
5347
  */
5071
5348
  'state'?: V4WorkflowsWorkflowIdGet200ResponseStateEnum;
5072
5349
  /**
5073
- * Display state for frontend
5350
+ * Computed status shown to users. Combines state + runState. ACTIVE = complete/scheduled, FAILED = last run failed, RUNNING = job in progress, DEGRADED = monitor experiencing issues (15-60 min stale).
5074
5351
  */
5075
5352
  'displayState'?: V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum;
5076
5353
  /**
@@ -5135,9 +5412,9 @@ interface V4WorkflowsWorkflowIdGet200Response {
5135
5412
  */
5136
5413
  'runCosts'?: number;
5137
5414
  /**
5138
- * State of the last job run
5415
+ * Latest job execution state. RUNNING = job in progress, FINISHED = completed successfully, FAILED = job failed.
5139
5416
  */
5140
- 'runState'?: string;
5417
+ 'runState'?: V4WorkflowsWorkflowIdGet200ResponseRunStateEnum;
5141
5418
  /**
5142
5419
  * Total number of records extracted
5143
5420
  */
@@ -5189,6 +5466,11 @@ interface V4WorkflowsWorkflowIdGet200Response {
5189
5466
  'dataValidation'?: V4WorkflowsWorkflowIdGet200ResponseDataValidation;
5190
5467
  'validationStatistics'?: V4WorkflowsWorkflowIdGet200ResponseValidationStatistics;
5191
5468
  'notificationConfig'?: V4WorkflowsWorkflowIdGet200ResponseNotificationConfig;
5469
+ /**
5470
+ * List of open support requests for this workflow. Only present when there are open requests.
5471
+ */
5472
+ 'openSupportRequests'?: Array<V4WorkflowsWorkflowIdGet200ResponseOpenSupportRequestsInner>;
5473
+ 'observerHealth'?: V4WorkflowsWorkflowIdGet200ResponseObserverHealth | null;
5192
5474
  }
5193
5475
  declare const V4WorkflowsWorkflowIdGet200ResponseStateEnum: {
5194
5476
  readonly Active: "ACTIVE";
@@ -5209,16 +5491,23 @@ declare const V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum: {
5209
5491
  readonly Paused: "PAUSED";
5210
5492
  readonly NotSupported: "NOT_SUPPORTED";
5211
5493
  readonly Preview: "PREVIEW";
5212
- readonly ComplianceReview: "COMPLIANCE_REVIEW";
5213
- readonly ComplianceRejected: "COMPLIANCE_REJECTED";
5214
5494
  readonly Queued: "QUEUED";
5215
5495
  readonly Setup: "SETUP";
5216
5496
  readonly PendingStart: "PENDING_START";
5217
5497
  readonly Running: "RUNNING";
5218
5498
  readonly Failed: "FAILED";
5499
+ readonly Degraded: "DEGRADED";
5500
+ readonly ComplianceReview: "COMPLIANCE_REVIEW";
5501
+ readonly ComplianceRejected: "COMPLIANCE_REJECTED";
5219
5502
  readonly Deleted: "DELETED";
5220
5503
  };
5221
5504
  type V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum = typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum];
5505
+ declare const V4WorkflowsWorkflowIdGet200ResponseRunStateEnum: {
5506
+ readonly Running: "RUNNING";
5507
+ readonly Finished: "FINISHED";
5508
+ readonly Failed: "FAILED";
5509
+ };
5510
+ type V4WorkflowsWorkflowIdGet200ResponseRunStateEnum = typeof V4WorkflowsWorkflowIdGet200ResponseRunStateEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseRunStateEnum];
5222
5511
  declare const V4WorkflowsWorkflowIdGet200ResponseNavigationModeEnum: {
5223
5512
  readonly SinglePage: "single-page";
5224
5513
  readonly PaginatedPage: "paginated-page";
@@ -6865,14 +7154,14 @@ interface DataValidationApiInterface {
6865
7154
  */
6866
7155
  v4DataValidationRulesActionsDeleteAllDelete(requestParameters?: DataValidationApiV4DataValidationRulesActionsDeleteAllDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteAllRulesResponse>;
6867
7156
  /**
6868
- * Generate a validation rule
7157
+ * Generate a validation rule using AI
6869
7158
  * @param {DataValidationApiV4DataValidationRulesActionsGeneratePostRequest} requestParameters Request parameters.
6870
7159
  * @param {*} [options] Override http request option.
6871
7160
  * @throws {RequiredError}
6872
7161
  */
6873
7162
  v4DataValidationRulesActionsGeneratePost(requestParameters?: DataValidationApiV4DataValidationRulesActionsGeneratePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateRuleResponse>;
6874
7163
  /**
6875
- * Generate multiple validation rules
7164
+ * Generate multiple validation rules using AI
6876
7165
  * @param {DataValidationApiV4DataValidationRulesActionsGenerateRulesPostRequest} requestParameters Request parameters.
6877
7166
  * @param {*} [options] Override http request option.
6878
7167
  * @throws {RequiredError}
@@ -6885,13 +7174,6 @@ interface DataValidationApiInterface {
6885
7174
  * @throws {RequiredError}
6886
7175
  */
6887
7176
  v4DataValidationRulesGet(requestParameters?: DataValidationApiV4DataValidationRulesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RulesListResponse>;
6888
- /**
6889
- * Create a new validation rule
6890
- * @param {DataValidationApiV4DataValidationRulesPostRequest} requestParameters Request parameters.
6891
- * @param {*} [options] Override http request option.
6892
- * @throws {RequiredError}
6893
- */
6894
- v4DataValidationRulesPost(requestParameters?: DataValidationApiV4DataValidationRulesPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RuleCreateResponse>;
6895
7177
  /**
6896
7178
  * Delete a validation rule with reason
6897
7179
  * @param {DataValidationApiV4DataValidationRulesRuleIdDeleteRequest} requestParameters Request parameters.
@@ -6913,13 +7195,6 @@ interface DataValidationApiInterface {
6913
7195
  * @throws {RequiredError}
6914
7196
  */
6915
7197
  v4DataValidationRulesRuleIdGet(requestParameters: DataValidationApiV4DataValidationRulesRuleIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RuleResponse>;
6916
- /**
6917
- * Update a validation rule
6918
- * @param {DataValidationApiV4DataValidationRulesRuleIdPutRequest} requestParameters Request parameters.
6919
- * @param {*} [options] Override http request option.
6920
- * @throws {RequiredError}
6921
- */
6922
- v4DataValidationRulesRuleIdPut(requestParameters: DataValidationApiV4DataValidationRulesRuleIdPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<RuleUpdateResponse>;
6923
7198
  /**
6924
7199
  * Get all anomalies for a validation
6925
7200
  * @summary Get validation anomalies
@@ -7065,15 +7340,6 @@ interface DataValidationApiV4DataValidationRulesGetRequest {
7065
7340
  readonly pageSize?: number;
7066
7341
  readonly includeDeleted?: V4DataValidationRulesGetIncludeDeletedParameter;
7067
7342
  }
7068
- /**
7069
- * Request parameters for v4DataValidationRulesPost operation in DataValidationApi.
7070
- */
7071
- interface DataValidationApiV4DataValidationRulesPostRequest {
7072
- /**
7073
- * Body
7074
- */
7075
- readonly createRule?: CreateRule;
7076
- }
7077
7343
  /**
7078
7344
  * Request parameters for v4DataValidationRulesRuleIdDelete operation in DataValidationApi.
7079
7345
  */
@@ -7101,16 +7367,6 @@ interface DataValidationApiV4DataValidationRulesRuleIdGetRequest {
7101
7367
  readonly ruleId: string;
7102
7368
  readonly includeDeleted?: boolean;
7103
7369
  }
7104
- /**
7105
- * Request parameters for v4DataValidationRulesRuleIdPut operation in DataValidationApi.
7106
- */
7107
- interface DataValidationApiV4DataValidationRulesRuleIdPutRequest {
7108
- readonly ruleId: string;
7109
- /**
7110
- * Body
7111
- */
7112
- readonly updateRule?: UpdateRule;
7113
- }
7114
7370
  /**
7115
7371
  * Request parameters for v4DataValidationValidationsValidationIdAnomaliesGet operation in DataValidationApi.
7116
7372
  */
@@ -7264,14 +7520,14 @@ declare class DataValidationApi extends BaseAPI implements DataValidationApiInte
7264
7520
  */
7265
7521
  v4DataValidationRulesActionsDeleteAllDelete(requestParameters?: DataValidationApiV4DataValidationRulesActionsDeleteAllDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<DeleteAllRulesResponse, any, {}>>;
7266
7522
  /**
7267
- * Generate a validation rule
7523
+ * Generate a validation rule using AI
7268
7524
  * @param {DataValidationApiV4DataValidationRulesActionsGeneratePostRequest} requestParameters Request parameters.
7269
7525
  * @param {*} [options] Override http request option.
7270
7526
  * @throws {RequiredError}
7271
7527
  */
7272
7528
  v4DataValidationRulesActionsGeneratePost(requestParameters?: DataValidationApiV4DataValidationRulesActionsGeneratePostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GenerateRuleResponse, any, {}>>;
7273
7529
  /**
7274
- * Generate multiple validation rules
7530
+ * Generate multiple validation rules using AI
7275
7531
  * @param {DataValidationApiV4DataValidationRulesActionsGenerateRulesPostRequest} requestParameters Request parameters.
7276
7532
  * @param {*} [options] Override http request option.
7277
7533
  * @throws {RequiredError}
@@ -7284,13 +7540,6 @@ declare class DataValidationApi extends BaseAPI implements DataValidationApiInte
7284
7540
  * @throws {RequiredError}
7285
7541
  */
7286
7542
  v4DataValidationRulesGet(requestParameters?: DataValidationApiV4DataValidationRulesGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RulesListResponse, any, {}>>;
7287
- /**
7288
- * Create a new validation rule
7289
- * @param {DataValidationApiV4DataValidationRulesPostRequest} requestParameters Request parameters.
7290
- * @param {*} [options] Override http request option.
7291
- * @throws {RequiredError}
7292
- */
7293
- v4DataValidationRulesPost(requestParameters?: DataValidationApiV4DataValidationRulesPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RuleCreateResponse, any, {}>>;
7294
7543
  /**
7295
7544
  * Delete a validation rule with reason
7296
7545
  * @param {DataValidationApiV4DataValidationRulesRuleIdDeleteRequest} requestParameters Request parameters.
@@ -7312,13 +7561,6 @@ declare class DataValidationApi extends BaseAPI implements DataValidationApiInte
7312
7561
  * @throws {RequiredError}
7313
7562
  */
7314
7563
  v4DataValidationRulesRuleIdGet(requestParameters: DataValidationApiV4DataValidationRulesRuleIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RuleResponse, any, {}>>;
7315
- /**
7316
- * Update a validation rule
7317
- * @param {DataValidationApiV4DataValidationRulesRuleIdPutRequest} requestParameters Request parameters.
7318
- * @param {*} [options] Override http request option.
7319
- * @throws {RequiredError}
7320
- */
7321
- v4DataValidationRulesRuleIdPut(requestParameters: DataValidationApiV4DataValidationRulesRuleIdPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RuleUpdateResponse, any, {}>>;
7322
7564
  /**
7323
7565
  * Get all anomalies for a validation
7324
7566
  * @summary Get validation anomalies
@@ -7943,6 +8185,14 @@ interface WorkflowsApiInterface {
7943
8185
  * @throws {RequiredError}
7944
8186
  */
7945
8187
  v4ChangesChangeIdGet(requestParameters: WorkflowsApiV4ChangesChangeIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V4ChangesGet200ResponseChangesInner>;
8188
+ /**
8189
+ *
8190
+ * @summary Download a change PDF file
8191
+ * @param {WorkflowsApiV4ChangesFilesEncodedPathGetRequest} requestParameters Request parameters.
8192
+ * @param {*} [options] Override http request option.
8193
+ * @throws {RequiredError}
8194
+ */
8195
+ v4ChangesFilesEncodedPathGet(requestParameters: WorkflowsApiV4ChangesFilesEncodedPathGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
7946
8196
  /**
7947
8197
  *
7948
8198
  * @summary Get all data changes
@@ -7951,6 +8201,14 @@ interface WorkflowsApiInterface {
7951
8201
  * @throws {RequiredError}
7952
8202
  */
7953
8203
  v4ChangesGet(requestParameters?: WorkflowsApiV4ChangesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V4ChangesGet200Response>;
8204
+ /**
8205
+ * Execute actions on multiple workflows at once. Best-effort processing - each workflow is processed independently. The \'approve\' action approves sample data for workflows in PREVIEW state.
8206
+ * @summary Perform bulk operations on multiple workflows
8207
+ * @param {WorkflowsApiV4WorkflowsBulkPostRequest} requestParameters Request parameters.
8208
+ * @param {*} [options] Override http request option.
8209
+ * @throws {RequiredError}
8210
+ */
8211
+ v4WorkflowsBulkPost(requestParameters: WorkflowsApiV4WorkflowsBulkPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<V4WorkflowsBulkPost200Response>;
7954
8212
  /**
7955
8213
  * Retrieves a list of workflows with pagination and search capabilities
7956
8214
  * @summary Get a list of workflows
@@ -8113,6 +8371,23 @@ interface WorkflowsApiV4ChangesChangeIdGetRequest {
8113
8371
  */
8114
8372
  readonly authorization?: string;
8115
8373
  }
8374
+ /**
8375
+ * Request parameters for v4ChangesFilesEncodedPathGet operation in WorkflowsApi.
8376
+ */
8377
+ interface WorkflowsApiV4ChangesFilesEncodedPathGetRequest {
8378
+ /**
8379
+ * Base64-encoded file path
8380
+ */
8381
+ readonly encodedPath: string;
8382
+ /**
8383
+ * API key for authorization
8384
+ */
8385
+ readonly xApiKey?: string;
8386
+ /**
8387
+ * Bearer token for authorization
8388
+ */
8389
+ readonly authorization?: string;
8390
+ }
8116
8391
  /**
8117
8392
  * Request parameters for v4ChangesGet operation in WorkflowsApi.
8118
8393
  */
@@ -8150,6 +8425,12 @@ interface WorkflowsApiV4ChangesGetRequest {
8150
8425
  */
8151
8426
  readonly exclude?: string;
8152
8427
  }
8428
+ /**
8429
+ * Request parameters for v4WorkflowsBulkPost operation in WorkflowsApi.
8430
+ */
8431
+ interface WorkflowsApiV4WorkflowsBulkPostRequest {
8432
+ readonly v4WorkflowsBulkPostRequest: V4WorkflowsBulkPostRequest;
8433
+ }
8153
8434
  /**
8154
8435
  * Request parameters for v4WorkflowsGet operation in WorkflowsApi.
8155
8436
  */
@@ -8167,9 +8448,21 @@ interface WorkflowsApiV4WorkflowsGetRequest {
8167
8448
  */
8168
8449
  readonly limit?: number;
8169
8450
  /**
8170
- * Filter workflows by state
8451
+ * Filter workflows by persisted workflow state. Use inSupport param to filter by support status.
8171
8452
  */
8172
8453
  readonly state?: V4WorkflowsGetStateEnum;
8454
+ /**
8455
+ * Filter workflows by latest job run state (e.g., FAILED)
8456
+ */
8457
+ readonly runState?: V4WorkflowsGetRunStateEnum;
8458
+ /**
8459
+ * Filter workflows by computed display state (comma-separated for multiple)
8460
+ */
8461
+ readonly displayState?: V4WorkflowsGetDisplayStateEnum;
8462
+ /**
8463
+ * Filter workflows by support status (has open support request)
8464
+ */
8465
+ readonly inSupport?: V4WorkflowsGetInSupportEnum;
8173
8466
  /**
8174
8467
  * Filter workflows by tags
8175
8468
  */
@@ -8503,6 +8796,14 @@ declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterface {
8503
8796
  * @throws {RequiredError}
8504
8797
  */
8505
8798
  v4ChangesChangeIdGet(requestParameters: WorkflowsApiV4ChangesChangeIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<V4ChangesGet200ResponseChangesInner, any, {}>>;
8799
+ /**
8800
+ *
8801
+ * @summary Download a change PDF file
8802
+ * @param {WorkflowsApiV4ChangesFilesEncodedPathGetRequest} requestParameters Request parameters.
8803
+ * @param {*} [options] Override http request option.
8804
+ * @throws {RequiredError}
8805
+ */
8806
+ v4ChangesFilesEncodedPathGet(requestParameters: WorkflowsApiV4ChangesFilesEncodedPathGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<File, any, {}>>;
8506
8807
  /**
8507
8808
  *
8508
8809
  * @summary Get all data changes
@@ -8511,6 +8812,14 @@ declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterface {
8511
8812
  * @throws {RequiredError}
8512
8813
  */
8513
8814
  v4ChangesGet(requestParameters?: WorkflowsApiV4ChangesGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<V4ChangesGet200Response, any, {}>>;
8815
+ /**
8816
+ * Execute actions on multiple workflows at once. Best-effort processing - each workflow is processed independently. The \'approve\' action approves sample data for workflows in PREVIEW state.
8817
+ * @summary Perform bulk operations on multiple workflows
8818
+ * @param {WorkflowsApiV4WorkflowsBulkPostRequest} requestParameters Request parameters.
8819
+ * @param {*} [options] Override http request option.
8820
+ * @throws {RequiredError}
8821
+ */
8822
+ v4WorkflowsBulkPost(requestParameters: WorkflowsApiV4WorkflowsBulkPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<V4WorkflowsBulkPost200Response, any, {}>>;
8514
8823
  /**
8515
8824
  * Retrieves a list of workflows with pagination and search capabilities
8516
8825
  * @summary Get a list of workflows
@@ -8658,11 +8967,39 @@ declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterface {
8658
8967
  }
8659
8968
  declare const V4WorkflowsGetStateEnum: {
8660
8969
  readonly Active: "ACTIVE";
8661
- readonly Error: "ERROR";
8662
8970
  readonly Paused: "PAUSED";
8971
+ readonly Preview: "PREVIEW";
8972
+ readonly Queued: "QUEUED";
8973
+ readonly Setup: "SETUP";
8974
+ readonly ComplianceReview: "COMPLIANCE_REVIEW";
8975
+ readonly ComplianceRejected: "COMPLIANCE_REJECTED";
8663
8976
  readonly NotSupported: "NOT_SUPPORTED";
8977
+ readonly Error: "ERROR";
8978
+ readonly Deleted: "DELETED";
8664
8979
  };
8665
8980
  type V4WorkflowsGetStateEnum = typeof V4WorkflowsGetStateEnum[keyof typeof V4WorkflowsGetStateEnum];
8981
+ declare const V4WorkflowsGetRunStateEnum: {
8982
+ readonly Failed: "FAILED";
8983
+ readonly Finished: "FINISHED";
8984
+ readonly Running: "RUNNING";
8985
+ };
8986
+ type V4WorkflowsGetRunStateEnum = typeof V4WorkflowsGetRunStateEnum[keyof typeof V4WorkflowsGetRunStateEnum];
8987
+ declare const V4WorkflowsGetDisplayStateEnum: {
8988
+ readonly Active: "ACTIVE";
8989
+ readonly Paused: "PAUSED";
8990
+ readonly Preview: "PREVIEW";
8991
+ readonly Failed: "FAILED";
8992
+ readonly Running: "RUNNING";
8993
+ readonly PendingStart: "PENDING_START";
8994
+ readonly ComplianceReview: "COMPLIANCE_REVIEW";
8995
+ readonly ComplianceRejected: "COMPLIANCE_REJECTED";
8996
+ };
8997
+ type V4WorkflowsGetDisplayStateEnum = typeof V4WorkflowsGetDisplayStateEnum[keyof typeof V4WorkflowsGetDisplayStateEnum];
8998
+ declare const V4WorkflowsGetInSupportEnum: {
8999
+ readonly True: "true";
9000
+ readonly False: "false";
9001
+ };
9002
+ type V4WorkflowsGetInSupportEnum = typeof V4WorkflowsGetInSupportEnum[keyof typeof V4WorkflowsGetInSupportEnum];
8666
9003
  declare const V4WorkflowsGetMonitoringEnum: {
8667
9004
  readonly True: "true";
8668
9005
  readonly False: "false";
@@ -9071,9 +9408,15 @@ declare function validateAdditionalData(additionalData: unknown): void;
9071
9408
  */
9072
9409
  declare const WorkflowState: {
9073
9410
  readonly Active: "ACTIVE";
9074
- readonly Error: "ERROR";
9075
9411
  readonly Paused: "PAUSED";
9412
+ readonly Preview: "PREVIEW";
9413
+ readonly Queued: "QUEUED";
9414
+ readonly Setup: "SETUP";
9415
+ readonly ComplianceReview: "COMPLIANCE_REVIEW";
9416
+ readonly ComplianceRejected: "COMPLIANCE_REJECTED";
9076
9417
  readonly NotSupported: "NOT_SUPPORTED";
9418
+ readonly Error: "ERROR";
9419
+ readonly Deleted: "DELETED";
9077
9420
  };
9078
9421
  type WorkflowState = (typeof WorkflowState)[keyof typeof WorkflowState];
9079
9422
  /**
@@ -9902,10 +10245,8 @@ declare class ListRulesRequest implements DataValidationApiV4DataValidationRules
9902
10245
  pageSize?: number;
9903
10246
  includeDeleted?: IncludeDeletedRules;
9904
10247
  }
9905
- type CreateRuleRequest = CreateRule;
9906
10248
  type GenerateRuleRequest = GenerateRule;
9907
10249
  type GenerateRulesRequest = GenerateRules;
9908
- type UpdateRuleRequest = UpdateRule;
9909
10250
  interface DisableRuleRequest {
9910
10251
  ruleId: string;
9911
10252
  disableRule?: DisableRule;
@@ -9974,8 +10315,6 @@ declare class ValidationRulesService {
9974
10315
  listRules(options?: ListRulesRequest): Promise<ListRulesResponse>;
9975
10316
  getRuleById(ruleId: string): Promise<Rule | undefined>;
9976
10317
  getRuleByName(name: string): Promise<Rule | undefined>;
9977
- createRule(data: CreateRuleRequest): Promise<Rule>;
9978
- updateRule(ruleId: string, updateData: UpdateRuleRequest): Promise<Rule>;
9979
10318
  deleteRule(data: DeleteRuleRequest): Promise<RuleDeleteResponse>;
9980
10319
  disableRule(data: DisableRuleRequest): Promise<Rule>;
9981
10320
  generateRule(data: GenerateRuleRequest): Promise<Rule>;
@@ -10028,13 +10367,31 @@ declare class ApiRegistry {
10028
10367
  get notifications(): NotificationsApi;
10029
10368
  }
10030
10369
 
10370
+ interface TeamInfo {
10371
+ id: string;
10372
+ name: string;
10373
+ role: string;
10374
+ memberRole: string;
10375
+ }
10376
+ interface BearerAuthOptions {
10377
+ bearerToken: string;
10378
+ }
10031
10379
  interface KadoaClientStatus {
10032
10380
  baseUrl: string;
10033
10381
  user: KadoaUser;
10034
10382
  realtimeConnected: boolean;
10035
10383
  }
10036
10384
  interface KadoaClientConfig {
10037
- apiKey: string;
10385
+ /**
10386
+ * Team API key (`tk-...`). Required unless `bearerToken` is provided.
10387
+ */
10388
+ apiKey?: string;
10389
+ /**
10390
+ * = JWT for Bearer auth. When set, requests send
10391
+ * `Authorization: Bearer <token>` instead of `x-api-key`.
10392
+ * Use {@link KadoaClient.setBearerToken} to update after refresh.
10393
+ */
10394
+ bearerToken?: string;
10038
10395
  /**
10039
10396
  * Override the base URL for the public API.
10040
10397
  *
@@ -10083,6 +10440,7 @@ declare class KadoaClient {
10083
10440
  private readonly _axiosInstance;
10084
10441
  private readonly _baseUrl;
10085
10442
  private readonly _apiKey;
10443
+ private _bearerToken;
10086
10444
  private _realtime?;
10087
10445
  private readonly _extractionBuilderService;
10088
10446
  readonly apis: ApiRegistry;
@@ -10109,9 +10467,15 @@ declare class KadoaClient {
10109
10467
  /**
10110
10468
  * Get the API key
10111
10469
  *
10112
- * @returns The API key
10470
+ * @returns The API key (empty string when using Bearer auth)
10113
10471
  */
10114
10472
  get apiKey(): string;
10473
+ /**
10474
+ * Update the Bearer token used for authentication.
10475
+ * Call this after a Supabase JWT refresh so that subsequent requests
10476
+ * use the new token.
10477
+ */
10478
+ setBearerToken(token: string): void;
10115
10479
  /**
10116
10480
  * Get the realtime connection (if enabled)
10117
10481
  */
@@ -10147,6 +10511,24 @@ declare class KadoaClient {
10147
10511
  * @returns The status of the client
10148
10512
  */
10149
10513
  status(): Promise<KadoaClientStatus>;
10514
+ /**
10515
+ * List all teams accessible to the authenticated user.
10516
+ *
10517
+ * When called with a Bearer token (Supabase JWT), returns all teams the
10518
+ * human user belongs to. Without it, falls back to x-api-key auth which
10519
+ * only returns teams the service account (API key) belongs to.
10520
+ */
10521
+ listTeams(opts?: BearerAuthOptions): Promise<TeamInfo[]>;
10522
+ /**
10523
+ * Switch the active team for this session.
10524
+ *
10525
+ * Calls `POST /v5/auth/active-team` which updates the server-side
10526
+ * session→team mapping. Subsequent requests with the same JWT are
10527
+ * automatically scoped to the new team — no token refresh needed.
10528
+ *
10529
+ * @param teamId - The team ID to switch to (must be a team the user belongs to)
10530
+ */
10531
+ setActiveTeam(teamId: string): Promise<void>;
10150
10532
  /**
10151
10533
  * Dispose of the client and clean up resources
10152
10534
  */
@@ -10314,4 +10696,4 @@ declare class KadoaHttpException extends KadoaSdkException {
10314
10696
  static mapStatusToCode(errorOrStatus: AxiosError | number): KadoaErrorCode;
10315
10697
  }
10316
10698
 
10317
- export { type ArtifactOptions, type BlueprintItem, type BulkApproveRulesRequest, type BulkApproveRulesResponseData, type BulkDeleteRulesRequest, type BulkDeleteRulesResponseData, type Category, type ChannelConfig, type ChannelSetupRequestConfig, type CrawlMethod, type CrawlerConfig, CrawlerConfigService, type CrawlerDomain, type CrawlerExtractionOptions, type CrawlerSession, CrawlerSessionService, type CreateChannelRequest, type CreateConfigRequest, type CreateRuleRequest, type CreateSchemaRequest, type CreateSettingsRequest, type CreateWorkflowInput, type CreateWorkflowRequest, type CreateWorkflowWithCustomSchemaRequest, type CreatedExtraction, DataFetcherService, type DataFieldFor, type DataPagination, DataSortOrder, type DataType, type DataTypeNotRequiringExample, type DataTypeRequiringExample, type DeleteAllRulesRequest, type DeleteAllRulesResponseData, type DeleteConfigRequest, type DeleteConfigResult, type DisableRuleRequest, ERROR_MESSAGES, type EmailChannelConfig, EntityResolverService, type ExtractOptions, ExtractionBuilderService, type ExtractionOptions, type ExtractionResult, ExtractionService, FetchDataOptions, type FetchDataResult, type FieldExample, type FieldOptions, type FieldOptionsWithExample, type FieldOptionsWithoutExample, type FieldType, type FinishedExtraction, type GenerateRuleRequest, type GenerateRulesRequest, type GetAllDataOptions, type GetAnomaliesByRuleResponse, type GetAnomalyRulePageResponse, type GetBucketFileOptions, type GetJobResponse, type GetPageOptions, type GetPagesOptions, type GetValidationResponse, type GetWorkflowResponse, type JobId, JobStateEnum, type JobWaitOptions, KadoaClient, type KadoaClientConfig, type KadoaClientStatus, KadoaErrorCode, KadoaHttpException, KadoaSdkException, type KadoaUser, ListChannelsRequest, ListRulesRequest, type ListRulesResponse, type ListSessionsOptions, type ListSessionsResult, ListSettingsRequest, type ListValidationsResponse, ListWorkflowValidationsRequest, ListWorkflowsRequest, type LocationConfig, type MetadataKey, type MonitoringConfig, type MonitoringField, type MonitoringOperator, MonitoringStatus, type NavigationMode, type NavigationOptions, type NotificationChannel, type NotificationChannelConfig, NotificationChannelType, NotificationChannelsService, type NotificationDomain, type NotificationOptions, type NotificationSettings, type NotificationSettingsEventType, V5NotificationsSettingsGetEventTypeEnum as NotificationSettingsEventTypeEnum, NotificationSettingsService, type NotificationSetupRequestChannels, NotificationSetupService, type PageContent, PageStatus, type PaginationInfo, type PollingOptions, type PreparedExtraction, type RawFormat, Realtime, type RealtimeConfig, type RealtimeEvent, ResponseFormat, type Rule, RuleStatus, RuleType, type RunWorkflowRequest, type RunWorkflowResponse, type ScheduleValidationResponse, SchemaBuilder, type SchemaField as SchemaDefinitionField, type SchemaField$1 as SchemaField, SchemaFieldDataType, type SchemaResponse, SchemasService, type SessionDataItem, type SessionDataList, type SessionOperationResult, type SessionPage, type SessionPagesResult, type SessionStatus, type SetupWorkflowNotificationSettingsRequest, type SetupWorkspaceNotificationSettingsRequest, type SlackChannelConfig, type StartCrawlRequest, type StartSessionResult, type StartWithConfigRequest, type SubmitExtractionResult, type SubmittedExtraction, TERMINAL_JOB_STATES, TERMINAL_RUN_STATES, type TestNotificationRequest, type TestNotificationResult, type ToggleValidationResponse, UpdateInterval, type UpdateRuleRequest, type UpdateSchemaRequest, type UpdateWorkflowRequest, type UpdateWorkflowResponse, UserService, ValidationCoreService, type ValidationDomain, ValidationRulesService, ValidationStrategy, type WaitForReadyOptions, type WaitOptions, type WebhookChannelConfig, type WebhookChannelConfigAuth, type WebhookHttpMethod, type WebsocketChannelConfig, type WorkflowDataResponse, type WorkflowDetailsResponse, WorkflowDisplayStateEnum, type WorkflowId, type WorkflowInterval, type WorkflowMonitoringConfig, type WorkflowResponse, WorkflowState, WorkflowStateEnum, type WorkflowsApiInterface, WorkflowsCoreService, createCrawlerDomain, pollUntil, validateAdditionalData };
10699
+ export { type ArtifactOptions, type BearerAuthOptions, type BlueprintItem, type BulkApproveRulesRequest, type BulkApproveRulesResponseData, type BulkDeleteRulesRequest, type BulkDeleteRulesResponseData, type Category, type ChannelConfig, type ChannelSetupRequestConfig, type CrawlMethod, type CrawlerConfig, CrawlerConfigService, type CrawlerDomain, type CrawlerExtractionOptions, type CrawlerSession, CrawlerSessionService, type CreateChannelRequest, type CreateConfigRequest, type CreateSchemaRequest, type CreateSettingsRequest, type CreateWorkflowInput, type CreateWorkflowRequest, type CreateWorkflowWithCustomSchemaRequest, type CreatedExtraction, DataFetcherService, type DataFieldFor, type DataPagination, DataSortOrder, type DataType, type DataTypeNotRequiringExample, type DataTypeRequiringExample, type DeleteAllRulesRequest, type DeleteAllRulesResponseData, type DeleteConfigRequest, type DeleteConfigResult, type DisableRuleRequest, ERROR_MESSAGES, type EmailChannelConfig, EntityResolverService, type ExtractOptions, ExtractionBuilderService, type ExtractionOptions, type ExtractionResult, ExtractionService, FetchDataOptions, type FetchDataResult, type FieldExample, type FieldOptions, type FieldOptionsWithExample, type FieldOptionsWithoutExample, type FieldType, type FinishedExtraction, type GenerateRuleRequest, type GenerateRulesRequest, type GetAllDataOptions, type GetAnomaliesByRuleResponse, type GetAnomalyRulePageResponse, type GetBucketFileOptions, type GetJobResponse, type GetPageOptions, type GetPagesOptions, type GetValidationResponse, type GetWorkflowResponse, type JobId, JobStateEnum, type JobWaitOptions, KadoaClient, type KadoaClientConfig, type KadoaClientStatus, KadoaErrorCode, KadoaHttpException, KadoaSdkException, type KadoaUser, ListChannelsRequest, ListRulesRequest, type ListRulesResponse, type ListSessionsOptions, type ListSessionsResult, ListSettingsRequest, type ListValidationsResponse, ListWorkflowValidationsRequest, ListWorkflowsRequest, type LocationConfig, type MetadataKey, type MonitoringConfig, type MonitoringField, type MonitoringOperator, MonitoringStatus, type NavigationMode, type NavigationOptions, type NotificationChannel, type NotificationChannelConfig, NotificationChannelType, NotificationChannelsService, type NotificationDomain, type NotificationOptions, type NotificationSettings, type NotificationSettingsEventType, V5NotificationsSettingsGetEventTypeEnum as NotificationSettingsEventTypeEnum, NotificationSettingsService, type NotificationSetupRequestChannels, NotificationSetupService, type PageContent, PageStatus, type PaginationInfo, type PollingOptions, type PreparedExtraction, type RawFormat, Realtime, type RealtimeConfig, type RealtimeEvent, ResponseFormat, type Rule, RuleStatus, RuleType, type RunWorkflowRequest, type RunWorkflowResponse, type ScheduleValidationResponse, SchemaBuilder, type SchemaField as SchemaDefinitionField, type SchemaField$1 as SchemaField, SchemaFieldDataType, type SchemaResponse, SchemasService, type SessionDataItem, type SessionDataList, type SessionOperationResult, type SessionPage, type SessionPagesResult, type SessionStatus, type SetupWorkflowNotificationSettingsRequest, type SetupWorkspaceNotificationSettingsRequest, type SlackChannelConfig, type StartCrawlRequest, type StartSessionResult, type StartWithConfigRequest, type SubmitExtractionResult, type SubmittedExtraction, TERMINAL_JOB_STATES, TERMINAL_RUN_STATES, type TeamInfo, type TestNotificationRequest, type TestNotificationResult, type ToggleValidationResponse, UpdateInterval, type UpdateSchemaRequest, type UpdateWorkflowRequest, type UpdateWorkflowResponse, UserService, ValidationCoreService, type ValidationDomain, ValidationRulesService, ValidationStrategy, type WaitForReadyOptions, type WaitOptions, type WebhookChannelConfig, type WebhookChannelConfigAuth, type WebhookHttpMethod, type WebsocketChannelConfig, type WorkflowDataResponse, type WorkflowDetailsResponse, WorkflowDisplayStateEnum, type WorkflowId, type WorkflowInterval, type WorkflowMonitoringConfig, type WorkflowResponse, WorkflowState, WorkflowStateEnum, type WorkflowsApiInterface, WorkflowsCoreService, createCrawlerDomain, pollUntil, validateAdditionalData };