@kadoa/node-sdk 0.15.0 → 0.16.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -87,56 +87,57 @@ declare class Configuration {
87
87
  * Do not edit the class manually.
88
88
  */
89
89
  /**
90
- * Raw anomaly data with rule and column information
91
- */
92
- interface AnomalyRow {
93
- '__rule__': string;
94
- '__id__': string;
95
- '__column__': string;
96
- '__type__': string;
97
- '__bad_value__'?: any | null;
98
- '__status__'?: AnomalyRowStatusEnum | null;
99
- }
100
- declare const AnomalyRowStatusEnum: {
101
- readonly New: "NEW";
102
- readonly Ongoing: "ONGOING";
103
- readonly Resolved: "RESOLVED";
104
- readonly Reopened: "REOPENED";
105
- };
106
- type AnomalyRowStatusEnum = typeof AnomalyRowStatusEnum[keyof typeof AnomalyRowStatusEnum];
107
-
108
- /**
109
- * Kadoa API
110
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
111
- *
112
- * The version of the OpenAPI document: 3.0.0
113
- * Contact: support@kadoa.com
114
- *
115
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
116
- * https://openapi-generator.tech
117
- * Do not edit the class manually.
90
+ * Browser interaction definition. Examples: - CLICK: {type: \'CLICK\', selector: \'#submit-btn\'} - TYPE: {type: \'TYPE\', text: \'hello world\'} - WAIT: {type: \'WAIT\', timeMs: 2000} - GOTO: {type: \'GOTO\', url: \'https://example.com\'} - ENTER/TAB/BACKSPACE/DELETE/REFRESH/NAVIGATE_BACK/SCROLL/HOVER/SELECT/LOAD/KEYPRESS: {type: \'ENTER\'} (no additional parameters needed)
118
91
  */
119
- /**
120
- * Metadata for paginated responses including page info and totals
121
- */
122
- interface PaginationMeta {
92
+ interface BrowserInteraction {
93
+ [key: string]: any;
123
94
  /**
124
- * Page number for pagination
95
+ * Type of interaction
125
96
  */
126
- 'page': number;
97
+ 'type': BrowserInteractionTypeEnum;
127
98
  /**
128
- * Number of items per page
99
+ * CSS selector for the target element (required for CLICK, HOVER)
129
100
  */
130
- 'pageSize': number;
101
+ 'selector'?: string;
131
102
  /**
132
- * Total number of items available
103
+ * Text to type (required for TYPE)
133
104
  */
134
- 'totalItems': number;
105
+ 'text'?: string;
135
106
  /**
136
- * Total number of pages
107
+ * Time in milliseconds (required for WAIT)
137
108
  */
138
- 'totalPages': number;
109
+ 'timeMs'?: number;
110
+ /**
111
+ * URL to navigate to (required for GOTO)
112
+ */
113
+ 'url'?: string;
114
+ /**
115
+ * HTML tag name of the element
116
+ */
117
+ 'tagName'?: string;
118
+ /**
119
+ * Inner text content of the element
120
+ */
121
+ 'innerText'?: string;
139
122
  }
123
+ declare const BrowserInteractionTypeEnum: {
124
+ readonly Click: "CLICK";
125
+ readonly Type: "TYPE";
126
+ readonly Hover: "HOVER";
127
+ readonly Scroll: "SCROLL";
128
+ readonly Wait: "WAIT";
129
+ readonly Keypress: "KEYPRESS";
130
+ readonly Load: "LOAD";
131
+ readonly Select: "SELECT";
132
+ readonly Backspace: "BACKSPACE";
133
+ readonly Enter: "ENTER";
134
+ readonly Tab: "TAB";
135
+ readonly Delete: "DELETE";
136
+ readonly Goto: "GOTO";
137
+ readonly Refresh: "REFRESH";
138
+ readonly NavigateBack: "NAVIGATE_BACK";
139
+ };
140
+ type BrowserInteractionTypeEnum = typeof BrowserInteractionTypeEnum[keyof typeof BrowserInteractionTypeEnum];
140
141
 
141
142
  /**
142
143
  * Kadoa API
@@ -149,14 +150,14 @@ interface PaginationMeta {
149
150
  * https://openapi-generator.tech
150
151
  * Do not edit the class manually.
151
152
  */
152
-
153
153
  /**
154
- * Anomalies grouped by rule with pagination
154
+ * Modifier keys state
155
155
  */
156
- interface AnomalyRuleData {
157
- 'ruleName': string;
158
- 'anomalies': Array<AnomalyRow>;
159
- 'pagination': PaginationMeta;
156
+ interface WebExtensionInteractionMetaKeys {
157
+ 'alt'?: boolean;
158
+ 'ctrl'?: boolean;
159
+ 'meta'?: boolean;
160
+ 'shift'?: boolean;
160
161
  }
161
162
 
162
163
  /**
@@ -170,12 +171,18 @@ interface AnomalyRuleData {
170
171
  * https://openapi-generator.tech
171
172
  * Do not edit the class manually.
172
173
  */
173
-
174
174
  /**
175
- * All anomalies grouped by validation rules
175
+ * Target element information
176
176
  */
177
- interface AnomaliesByRuleResponse {
178
- 'anomaliesByRule': Array<AnomalyRuleData>;
177
+ interface WebExtensionInteractionTarget {
178
+ 'id'?: string;
179
+ 'x'?: number;
180
+ 'y'?: number;
181
+ 'width'?: number;
182
+ 'height'?: number;
183
+ 'tagName'?: string;
184
+ 'html'?: string;
185
+ 'innerText'?: string;
179
186
  }
180
187
 
181
188
  /**
@@ -191,12 +198,52 @@ interface AnomaliesByRuleResponse {
191
198
  */
192
199
 
193
200
  /**
194
- * Paginated anomalies for a specific rule
201
+ * Web extension interaction in complex format
195
202
  */
196
- interface AnomalyRulePageResponse {
197
- 'ruleName': string;
198
- 'anomalies': Array<AnomalyRow>;
199
- 'pagination': PaginationMeta;
203
+ interface WebExtensionInteraction {
204
+ [key: string]: any;
205
+ /**
206
+ * Type of interaction
207
+ */
208
+ 'type': string;
209
+ /**
210
+ * Unique interaction ID
211
+ */
212
+ 'id'?: string;
213
+ /**
214
+ * X coordinate
215
+ */
216
+ 'x'?: number;
217
+ /**
218
+ * Y coordinate
219
+ */
220
+ 'y'?: number;
221
+ /**
222
+ * Page URL
223
+ */
224
+ 'link'?: string;
225
+ /**
226
+ * Timestamp
227
+ */
228
+ 'time'?: string;
229
+ /**
230
+ * URL to captured HTML body
231
+ */
232
+ 'bodyHTMLUrl'?: string;
233
+ /**
234
+ * URL to captured screenshot
235
+ */
236
+ 'screenshotUrl'?: string;
237
+ 'target'?: WebExtensionInteractionTarget;
238
+ /**
239
+ * Key value
240
+ */
241
+ 'key'?: string;
242
+ /**
243
+ * Key code
244
+ */
245
+ 'code'?: string;
246
+ 'metaKeys'?: WebExtensionInteractionMetaKeys;
200
247
  }
201
248
 
202
249
  /**
@@ -210,13 +257,12 @@ interface AnomalyRulePageResponse {
210
257
  * https://openapi-generator.tech
211
258
  * Do not edit the class manually.
212
259
  */
260
+
213
261
  /**
214
- * Request to bulk approve specific preview rules for a workflow
262
+ * @type Interaction
263
+ * Browser interaction definition. Accepts both simple format (with selector, text, url) and complex format from browser extensions
215
264
  */
216
- interface BulkApproveRules {
217
- 'workflowId': string;
218
- 'ruleIds': Array<string>;
219
- }
265
+ type Interaction = BrowserInteraction | WebExtensionInteraction;
220
266
 
221
267
  /**
222
268
  * Kadoa API
@@ -229,13 +275,24 @@ interface BulkApproveRules {
229
275
  * https://openapi-generator.tech
230
276
  * Do not edit the class manually.
231
277
  */
232
- interface BulkApproveRulesResponseData$1 {
233
- 'approvedCount': number;
234
- 'skippedCount': number;
235
- 'workflowId': string;
236
- 'approvedRuleIds': Array<string>;
237
- 'skippedRuleIds': Array<string>;
278
+ /**
279
+ * Geographic location for scraping. Use \'auto\' for automatic detection or \'manual\' to specify a country
280
+ */
281
+ interface Location {
282
+ /**
283
+ * Location type
284
+ */
285
+ 'type': LocationTypeEnum;
286
+ /**
287
+ * Country ISO code for manual location
288
+ */
289
+ 'isoCode'?: string;
238
290
  }
291
+ declare const LocationTypeEnum: {
292
+ readonly Auto: "auto";
293
+ readonly Manual: "manual";
294
+ };
295
+ type LocationTypeEnum = typeof LocationTypeEnum[keyof typeof LocationTypeEnum];
239
296
 
240
297
  /**
241
298
  * Kadoa API
@@ -248,15 +305,25 @@ interface BulkApproveRulesResponseData$1 {
248
305
  * https://openapi-generator.tech
249
306
  * Do not edit the class manually.
250
307
  */
251
-
252
308
  /**
253
- * Summary of bulk rule approval operation with detailed results
309
+ * Field monitoring configuration
254
310
  */
255
- interface BulkApproveRulesResponse {
256
- 'error': boolean;
257
- 'message': string;
258
- 'data': BulkApproveRulesResponseData$1;
311
+ interface MonitoredField {
312
+ /**
313
+ * Name of the field to monitor
314
+ */
315
+ 'fieldName': string;
316
+ /**
317
+ * Change operator
318
+ */
319
+ 'operator': MonitoredFieldOperatorEnum;
259
320
  }
321
+ declare const MonitoredFieldOperatorEnum: {
322
+ readonly Changed: "changed";
323
+ readonly Added: "added";
324
+ readonly Removed: "removed";
325
+ };
326
+ type MonitoredFieldOperatorEnum = typeof MonitoredFieldOperatorEnum[keyof typeof MonitoredFieldOperatorEnum];
260
327
 
261
328
  /**
262
329
  * Kadoa API
@@ -269,14 +336,37 @@ interface BulkApproveRulesResponse {
269
336
  * https://openapi-generator.tech
270
337
  * Do not edit the class manually.
271
338
  */
339
+
272
340
  /**
273
- * Request to bulk delete specific rules for a workflow
341
+ * Monitoring configuration
274
342
  */
275
- interface BulkDeleteRules {
276
- 'workflowId': string;
277
- 'ruleIds': Array<string>;
278
- 'reason'?: string;
343
+ interface MonitoringConfig {
344
+ /**
345
+ * Whether monitoring is enabled
346
+ */
347
+ 'enabled': boolean;
348
+ /**
349
+ * Fields to monitor
350
+ */
351
+ 'fields'?: Array<MonitoredField>;
352
+ /**
353
+ * Notification channels
354
+ */
355
+ 'channels'?: Array<any | null>;
356
+ /**
357
+ * Array of conditions
358
+ */
359
+ 'conditions'?: Array<null>;
360
+ /**
361
+ * Logical operator for conditions
362
+ */
363
+ 'logicalOperator'?: MonitoringConfigLogicalOperatorEnum;
279
364
  }
365
+ declare const MonitoringConfigLogicalOperatorEnum: {
366
+ readonly And: "AND";
367
+ readonly Or: "OR";
368
+ };
369
+ type MonitoringConfigLogicalOperatorEnum = typeof MonitoringConfigLogicalOperatorEnum[keyof typeof MonitoringConfigLogicalOperatorEnum];
280
370
 
281
371
  /**
282
372
  * Kadoa API
@@ -289,10 +379,15 @@ interface BulkDeleteRules {
289
379
  * https://openapi-generator.tech
290
380
  * Do not edit the class manually.
291
381
  */
292
- interface BulkDeleteRulesResponseData$1 {
293
- 'deletedCount': number;
294
- 'workflowId': string;
295
- 'deletedRuleIds': Array<string>;
382
+ interface ClassificationFieldCategoriesInner {
383
+ /**
384
+ * Short title/label of the category
385
+ */
386
+ 'title': string;
387
+ /**
388
+ * Full definition/description of the category
389
+ */
390
+ 'definition': string;
296
391
  }
297
392
 
298
393
  /**
@@ -308,13 +403,28 @@ interface BulkDeleteRulesResponseData$1 {
308
403
  */
309
404
 
310
405
  /**
311
- * Summary of bulk rule deletion operation with detailed results
406
+ * Categorize extracted data into predefined labels. Use this when you want the system to classify content into specific categories you define.
312
407
  */
313
- interface BulkDeleteRulesResponse {
314
- 'error': boolean;
315
- 'message': string;
316
- 'data': BulkDeleteRulesResponseData$1;
408
+ interface ClassificationField {
409
+ [key: string]: any;
410
+ /**
411
+ * Field name (letters and numbers only)
412
+ */
413
+ 'name': string;
414
+ /**
415
+ * Optional field description
416
+ */
417
+ 'description'?: string;
418
+ 'fieldType': ClassificationFieldFieldTypeEnum;
419
+ /**
420
+ * List of predefined categories for classification
421
+ */
422
+ 'categories': Array<ClassificationFieldCategoriesInner>;
317
423
  }
424
+ declare const ClassificationFieldFieldTypeEnum: {
425
+ readonly Classification: "CLASSIFICATION";
426
+ };
427
+ type ClassificationFieldFieldTypeEnum = typeof ClassificationFieldFieldTypeEnum[keyof typeof ClassificationFieldFieldTypeEnum];
318
428
 
319
429
  /**
320
430
  * Kadoa API
@@ -327,31 +437,11 @@ interface BulkDeleteRulesResponse {
327
437
  * https://openapi-generator.tech
328
438
  * Do not edit the class manually.
329
439
  */
330
- interface ChangeDetectionRecord {
331
- 'count': number;
332
- 'change': number;
333
- }
334
-
335
440
  /**
336
- * Kadoa API
337
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
338
- *
339
- * The version of the OpenAPI document: 3.0.0
340
- * Contact: support@kadoa.com
341
- *
342
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
343
- * https://openapi-generator.tech
344
- * Do not edit the class manually.
441
+ * @type DataFieldExample
442
+ * Example value for the field
345
443
  */
346
-
347
- interface ChangeDetectionResultAnomalyCountChanges {
348
- 'previousJobId': string;
349
- 'previousValidationId': string;
350
- 'anomaliesCountTotal': ChangeDetectionRecord;
351
- 'anomaliesCountByRule': {
352
- [key: string]: ChangeDetectionRecord;
353
- };
354
- }
444
+ type DataFieldExample = Array<string> | string;
355
445
 
356
446
  /**
357
447
  * Kadoa API
@@ -364,39 +454,47 @@ interface ChangeDetectionResultAnomalyCountChanges {
364
454
  * https://openapi-generator.tech
365
455
  * Do not edit the class manually.
366
456
  */
367
- interface ChangeDetectionResultStatusCounts {
368
- 'NEW': number;
369
- 'ONGOING': number;
370
- 'RESOLVED': number;
371
- 'REOPENED'?: number;
372
- }
373
457
 
374
458
  /**
375
- * Kadoa API
376
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
377
- *
378
- * The version of the OpenAPI document: 3.0.0
379
- * Contact: support@kadoa.com
380
- *
381
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
382
- * https://openapi-generator.tech
383
- * Do not edit the class manually.
459
+ * Extract and structure specific data from web pages with typed values (e.g., product prices, article titles, dates). Use this for actual data you want to capture.
384
460
  */
385
-
386
- interface ChangeDetectionResult {
461
+ interface DataField {
387
462
  /**
388
- * ISOLATED validates each dataset independently. LINKING_COLUMNS validates data integrity across linked columns between datasets.
463
+ * Field name (letters and numbers only)
389
464
  */
390
- 'strategy'?: ChangeDetectionResultStrategyEnum;
391
- 'anomalyCountChanges'?: ChangeDetectionResultAnomalyCountChanges;
392
- 'anomaliesStatusParquetPath'?: string;
393
- 'statusCounts'?: ChangeDetectionResultStatusCounts;
465
+ 'name': string;
466
+ /**
467
+ * Field description
468
+ */
469
+ 'description': string;
470
+ 'fieldType'?: DataFieldFieldTypeEnum;
471
+ 'example'?: DataFieldExample;
472
+ /**
473
+ * Data type of the field
474
+ */
475
+ 'dataType': DataFieldDataTypeEnum;
476
+ /**
477
+ * Whether the field is a key field
478
+ */
479
+ 'isKey'?: boolean;
394
480
  }
395
- declare const ChangeDetectionResultStrategyEnum: {
396
- readonly Isolated: "ISOLATED";
397
- readonly LinkingColumns: "LINKING_COLUMNS";
481
+ declare const DataFieldFieldTypeEnum: {
482
+ readonly Schema: "SCHEMA";
398
483
  };
399
- type ChangeDetectionResultStrategyEnum = typeof ChangeDetectionResultStrategyEnum[keyof typeof ChangeDetectionResultStrategyEnum];
484
+ type DataFieldFieldTypeEnum = typeof DataFieldFieldTypeEnum[keyof typeof DataFieldFieldTypeEnum];
485
+ declare const DataFieldDataTypeEnum: {
486
+ readonly String: "STRING";
487
+ readonly Number: "NUMBER";
488
+ readonly Boolean: "BOOLEAN";
489
+ readonly Date: "DATE";
490
+ readonly Datetime: "DATETIME";
491
+ readonly Money: "MONEY";
492
+ readonly Image: "IMAGE";
493
+ readonly Link: "LINK";
494
+ readonly Object: "OBJECT";
495
+ readonly Array: "ARRAY";
496
+ };
497
+ type DataFieldDataTypeEnum = typeof DataFieldDataTypeEnum[keyof typeof DataFieldDataTypeEnum];
400
498
 
401
499
  /**
402
500
  * Kadoa API
@@ -409,10 +507,35 @@ type ChangeDetectionResultStrategyEnum = typeof ChangeDetectionResultStrategyEnu
409
507
  * https://openapi-generator.tech
410
508
  * Do not edit the class manually.
411
509
  */
412
- interface CreateRuleParameters {
413
- 'sql'?: string;
414
- 'params'?: Array<any | null>;
510
+ /**
511
+ * Capture raw page content (HTML or Markdown) for further processing. Use this when you need the unstructured content for post-processing or AI analysis.
512
+ */
513
+ interface RawContentField {
514
+ [key: string]: any;
515
+ /**
516
+ * Field name (letters and numbers only)
517
+ */
518
+ 'name': string;
519
+ /**
520
+ * Optional field description
521
+ */
522
+ 'description'?: string;
523
+ 'fieldType': RawContentFieldFieldTypeEnum;
524
+ /**
525
+ * Key of the metadata field (html or markdown)
526
+ */
527
+ 'metadataKey': RawContentFieldMetadataKeyEnum;
415
528
  }
529
+ declare const RawContentFieldFieldTypeEnum: {
530
+ readonly Metadata: "METADATA";
531
+ };
532
+ type RawContentFieldFieldTypeEnum = typeof RawContentFieldFieldTypeEnum[keyof typeof RawContentFieldFieldTypeEnum];
533
+ declare const RawContentFieldMetadataKeyEnum: {
534
+ readonly Html: "HTML";
535
+ readonly Markdown: "MARKDOWN";
536
+ readonly PageUrl: "PAGE_URL";
537
+ };
538
+ type RawContentFieldMetadataKeyEnum = typeof RawContentFieldMetadataKeyEnum[keyof typeof RawContentFieldMetadataKeyEnum];
416
539
 
417
540
  /**
418
541
  * Kadoa API
@@ -427,30 +550,10 @@ interface CreateRuleParameters {
427
550
  */
428
551
 
429
552
  /**
430
- * Request body for creating a new validation rule
553
+ * @type SchemaResponseSchemaInner
554
+ * Extraction field schema
431
555
  */
432
- interface CreateRule {
433
- 'name': string;
434
- 'description'?: string;
435
- 'ruleType': CreateRuleRuleTypeEnum;
436
- 'workflowId'?: string;
437
- 'targetColumns'?: Array<string>;
438
- 'parameters': CreateRuleParameters;
439
- 'status'?: CreateRuleStatusEnum;
440
- 'metadata'?: {
441
- [key: string]: any | null;
442
- };
443
- }
444
- declare const CreateRuleRuleTypeEnum: {
445
- readonly CustomSql: "custom_sql";
446
- };
447
- type CreateRuleRuleTypeEnum = typeof CreateRuleRuleTypeEnum[keyof typeof CreateRuleRuleTypeEnum];
448
- declare const CreateRuleStatusEnum: {
449
- readonly Preview: "preview";
450
- readonly Enabled: "enabled";
451
- readonly Disabled: "disabled";
452
- };
453
- type CreateRuleStatusEnum = typeof CreateRuleStatusEnum[keyof typeof CreateRuleStatusEnum];
556
+ type SchemaResponseSchemaInner = ClassificationField | DataField | RawContentField;
454
557
 
455
558
  /**
456
559
  * Kadoa API
@@ -463,16 +566,107 @@ type CreateRuleStatusEnum = typeof CreateRuleStatusEnum[keyof typeof CreateRuleS
463
566
  * https://openapi-generator.tech
464
567
  * Do not edit the class manually.
465
568
  */
466
- interface ExtractionClassificationFieldCategoriesInner {
569
+
570
+ /**
571
+ * Create an AI-powered workflow that uses natural language instructions to intelligently extract and adapt data extraction based on page content. The agent can navigate complex sites and understand context. Example: `{\"urls\": [\"https://example.com\"], \"navigationMode\": \"agentic-navigation\", \"userPrompt\": \"Extract all job listings with title, company, salary, and location. Click on each listing to get full details.\"}`
572
+ */
573
+ interface AgenticWorkflow {
467
574
  /**
468
- * Short title/label of the category
575
+ * List of URLs to scrape. Can be a single URL or multiple URLs to scrape across different pages or domains.
469
576
  */
470
- 'title': string;
577
+ 'urls': Array<string>;
471
578
  /**
472
- * Full definition/description of the category
579
+ * Must be set to \'agentic-navigation\' for agentic workflows
473
580
  */
474
- 'definition': string;
581
+ 'navigationMode': AgenticWorkflowNavigationModeEnum;
582
+ /**
583
+ * Human-readable name for this workflow (e.g., \'Product Catalog Scraper\')
584
+ */
585
+ 'name'?: string;
586
+ /**
587
+ * Detailed description of what this workflow does and why it was created (maximum 500 characters)
588
+ */
589
+ 'description'?: string;
590
+ /**
591
+ * Tags for organizing and categorizing workflows (minimum 3 characters per tag)
592
+ */
593
+ 'tags'?: Array<string>;
594
+ /**
595
+ * Maximum number of items to scrape. Useful for limiting scope during development or cost control
596
+ */
597
+ 'limit'?: number;
598
+ 'location'?: Location;
599
+ 'monitoring'?: MonitoringConfig;
600
+ /**
601
+ * How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)
602
+ */
603
+ 'interval'?: AgenticWorkflowIntervalEnum;
604
+ /**
605
+ * Cron expressions for custom schedules. Overrides the interval setting for fine-grained control
606
+ */
607
+ 'schedules'?: Array<string>;
608
+ /**
609
+ * Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you\'re confident the configuration is correct
610
+ */
611
+ 'bypassPreview'?: boolean;
612
+ /**
613
+ * Automatically start the workflow after creation. Set to false if you want to test/review before starting
614
+ */
615
+ 'autoStart'?: boolean;
616
+ /**
617
+ * Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types
618
+ */
619
+ 'interactions'?: Array<Interaction>;
620
+ /**
621
+ * Enable data quality validation. When true, scraped data is validated against the schema and anomalies are detected
622
+ */
623
+ 'dataValidationEnabled'?: boolean;
624
+ /**
625
+ * Additional static data for the workflow (e.g. IDs from your system to link data)
626
+ */
627
+ 'additionalData'?: object | null;
628
+ /**
629
+ * Natural language instructions for the AI agent (10-5000 characters). Describe what data to extract and how to navigate the site
630
+ */
631
+ 'userPrompt': string;
632
+ /**
633
+ * Optional: Schema ID to use with agentic extraction
634
+ */
635
+ 'schemaId'?: string;
636
+ /**
637
+ * Optional: Entity name for agentic extraction
638
+ */
639
+ 'entity'?: string;
640
+ /**
641
+ * Optional: Additional extraction fields to guide the agent
642
+ */
643
+ 'fields'?: Array<SchemaResponseSchemaInner>;
475
644
  }
645
+ declare const AgenticWorkflowNavigationModeEnum: {
646
+ readonly AgenticNavigation: "agentic-navigation";
647
+ };
648
+ type AgenticWorkflowNavigationModeEnum = typeof AgenticWorkflowNavigationModeEnum[keyof typeof AgenticWorkflowNavigationModeEnum];
649
+ declare const AgenticWorkflowIntervalEnum: {
650
+ readonly OnlyOnce: "ONLY_ONCE";
651
+ readonly Every10Minutes: "EVERY_10_MINUTES";
652
+ readonly HalfHourly: "HALF_HOURLY";
653
+ readonly Hourly: "HOURLY";
654
+ readonly ThreeHourly: "THREE_HOURLY";
655
+ readonly SixHourly: "SIX_HOURLY";
656
+ readonly TwelveHourly: "TWELVE_HOURLY";
657
+ readonly EighteenHourly: "EIGHTEEN_HOURLY";
658
+ readonly Daily: "DAILY";
659
+ readonly TwoDay: "TWO_DAY";
660
+ readonly ThreeDay: "THREE_DAY";
661
+ readonly Weekly: "WEEKLY";
662
+ readonly Biweekly: "BIWEEKLY";
663
+ readonly Triweekly: "TRIWEEKLY";
664
+ readonly FourWeeks: "FOUR_WEEKS";
665
+ readonly Monthly: "MONTHLY";
666
+ readonly RealTime: "REAL_TIME";
667
+ readonly Custom: "CUSTOM";
668
+ };
669
+ type AgenticWorkflowIntervalEnum = typeof AgenticWorkflowIntervalEnum[keyof typeof AgenticWorkflowIntervalEnum];
476
670
 
477
671
  /**
478
672
  * Kadoa API
@@ -485,29 +679,24 @@ interface ExtractionClassificationFieldCategoriesInner {
485
679
  * https://openapi-generator.tech
486
680
  * Do not edit the class manually.
487
681
  */
488
-
489
682
  /**
490
- * Categorizes extracted data into predefined labels based on the content
683
+ * Raw anomaly data with rule and column information
491
684
  */
492
- interface ExtractionClassificationField {
493
- /**
494
- * Field name (letters and numbers only)
495
- */
496
- 'name': string;
497
- /**
498
- * Field description
499
- */
500
- 'description': string;
501
- 'fieldType': ExtractionClassificationFieldFieldTypeEnum;
502
- /**
503
- * List of predefined categories for classification
504
- */
505
- 'categories': Array<ExtractionClassificationFieldCategoriesInner>;
685
+ interface AnomalyRow {
686
+ '__rule__': string;
687
+ '__id__': string;
688
+ '__column__': string;
689
+ '__type__': string;
690
+ '__bad_value__'?: any | null;
691
+ '__status__'?: AnomalyRowStatusEnum | null;
506
692
  }
507
- declare const ExtractionClassificationFieldFieldTypeEnum: {
508
- readonly Classification: "CLASSIFICATION";
693
+ declare const AnomalyRowStatusEnum: {
694
+ readonly New: "NEW";
695
+ readonly Ongoing: "ONGOING";
696
+ readonly Resolved: "RESOLVED";
697
+ readonly Reopened: "REOPENED";
509
698
  };
510
- type ExtractionClassificationFieldFieldTypeEnum = typeof ExtractionClassificationFieldFieldTypeEnum[keyof typeof ExtractionClassificationFieldFieldTypeEnum];
699
+ type AnomalyRowStatusEnum = typeof AnomalyRowStatusEnum[keyof typeof AnomalyRowStatusEnum];
511
700
 
512
701
  /**
513
702
  * Kadoa API
@@ -521,33 +710,26 @@ type ExtractionClassificationFieldFieldTypeEnum = typeof ExtractionClassificatio
521
710
  * Do not edit the class manually.
522
711
  */
523
712
  /**
524
- * Exposes the raw page content in different formats (HTML, Markdown) for further processing
713
+ * Metadata for paginated responses including page info and totals
525
714
  */
526
- interface ExtractionMetadataField {
715
+ interface PaginationMeta {
527
716
  /**
528
- * Field name (letters and numbers only)
717
+ * Page number for pagination
529
718
  */
530
- 'name': string;
719
+ 'page': number;
531
720
  /**
532
- * Field description
721
+ * Number of items per page
533
722
  */
534
- 'description': string;
535
- 'fieldType': ExtractionMetadataFieldFieldTypeEnum;
723
+ 'pageSize': number;
536
724
  /**
537
- * Key of the metadata field (html or markdown)
725
+ * Total number of items available
726
+ */
727
+ 'totalItems': number;
728
+ /**
729
+ * Total number of pages
538
730
  */
539
- 'metadataKey': ExtractionMetadataFieldMetadataKeyEnum;
731
+ 'totalPages': number;
540
732
  }
541
- declare const ExtractionMetadataFieldFieldTypeEnum: {
542
- readonly Metadata: "METADATA";
543
- };
544
- type ExtractionMetadataFieldFieldTypeEnum = typeof ExtractionMetadataFieldFieldTypeEnum[keyof typeof ExtractionMetadataFieldFieldTypeEnum];
545
- declare const ExtractionMetadataFieldMetadataKeyEnum: {
546
- readonly Html: "HTML";
547
- readonly Markdown: "MARKDOWN";
548
- readonly PageUrl: "PAGE_URL";
549
- };
550
- type ExtractionMetadataFieldMetadataKeyEnum = typeof ExtractionMetadataFieldMetadataKeyEnum[keyof typeof ExtractionMetadataFieldMetadataKeyEnum];
551
733
 
552
734
  /**
553
735
  * Kadoa API
@@ -560,11 +742,15 @@ type ExtractionMetadataFieldMetadataKeyEnum = typeof ExtractionMetadataFieldMeta
560
742
  * https://openapi-generator.tech
561
743
  * Do not edit the class manually.
562
744
  */
745
+
563
746
  /**
564
- * @type ExtractionSchemaFieldExample
565
- * Example value for the field
747
+ * Anomalies grouped by rule with pagination
566
748
  */
567
- type ExtractionSchemaFieldExample = Array<string> | string;
749
+ interface AnomalyRuleData {
750
+ 'ruleName': string;
751
+ 'anomalies': Array<AnomalyRow>;
752
+ 'pagination': PaginationMeta;
753
+ }
568
754
 
569
755
  /**
570
756
  * Kadoa API
@@ -579,55 +765,128 @@ type ExtractionSchemaFieldExample = Array<string> | string;
579
765
  */
580
766
 
581
767
  /**
582
- * Extracts and structures specific data from web pages (e.g., product prices, article titles)
768
+ * All anomalies grouped by validation rules
583
769
  */
584
- interface ExtractionSchemaField {
585
- /**
586
- * Field name (letters and numbers only)
587
- */
588
- 'name': string;
589
- /**
590
- * Field description
591
- */
592
- 'description': string;
593
- 'fieldType'?: ExtractionSchemaFieldFieldTypeEnum;
594
- 'example'?: ExtractionSchemaFieldExample;
595
- /**
596
- * Data type of the field
597
- */
598
- 'dataType': ExtractionSchemaFieldDataTypeEnum;
599
- /**
600
- * Whether the field is a key field
601
- */
602
- 'isKey'?: boolean;
770
+ interface AnomaliesByRuleResponse {
771
+ 'anomaliesByRule': Array<AnomalyRuleData>;
772
+ }
773
+
774
+ /**
775
+ * Kadoa API
776
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
777
+ *
778
+ * The version of the OpenAPI document: 3.0.0
779
+ * Contact: support@kadoa.com
780
+ *
781
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
782
+ * https://openapi-generator.tech
783
+ * Do not edit the class manually.
784
+ */
785
+
786
+ /**
787
+ * Paginated anomalies for a specific rule
788
+ */
789
+ interface AnomalyRulePageResponse {
790
+ 'ruleName': string;
791
+ 'anomalies': Array<AnomalyRow>;
792
+ 'pagination': PaginationMeta;
793
+ }
794
+
795
+ /**
796
+ * Kadoa API
797
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
798
+ *
799
+ * The version of the OpenAPI document: 3.0.0
800
+ * Contact: support@kadoa.com
801
+ *
802
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
803
+ * https://openapi-generator.tech
804
+ * Do not edit the class manually.
805
+ */
806
+ /**
807
+ * Request to bulk approve specific preview rules for a workflow
808
+ */
809
+ interface BulkApproveRules {
810
+ 'workflowId': string;
811
+ 'ruleIds': Array<string>;
812
+ }
813
+
814
+ /**
815
+ * Kadoa API
816
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
817
+ *
818
+ * The version of the OpenAPI document: 3.0.0
819
+ * Contact: support@kadoa.com
820
+ *
821
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
822
+ * https://openapi-generator.tech
823
+ * Do not edit the class manually.
824
+ */
825
+ interface BulkApproveRulesResponseData$1 {
826
+ 'approvedCount': number;
827
+ 'skippedCount': number;
828
+ 'workflowId': string;
829
+ 'approvedRuleIds': Array<string>;
830
+ 'skippedRuleIds': Array<string>;
831
+ }
832
+
833
+ /**
834
+ * Kadoa API
835
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
836
+ *
837
+ * The version of the OpenAPI document: 3.0.0
838
+ * Contact: support@kadoa.com
839
+ *
840
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
841
+ * https://openapi-generator.tech
842
+ * Do not edit the class manually.
843
+ */
844
+
845
+ /**
846
+ * Summary of bulk rule approval operation with detailed results
847
+ */
848
+ interface BulkApproveRulesResponse {
849
+ 'error': boolean;
850
+ 'message': string;
851
+ 'data': BulkApproveRulesResponseData$1;
852
+ }
853
+
854
+ /**
855
+ * Kadoa API
856
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
857
+ *
858
+ * The version of the OpenAPI document: 3.0.0
859
+ * Contact: support@kadoa.com
860
+ *
861
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
862
+ * https://openapi-generator.tech
863
+ * Do not edit the class manually.
864
+ */
865
+ /**
866
+ * Request to bulk delete specific rules for a workflow
867
+ */
868
+ interface BulkDeleteRules {
869
+ 'workflowId': string;
870
+ 'ruleIds': Array<string>;
871
+ 'reason'?: string;
872
+ }
873
+
874
+ /**
875
+ * Kadoa API
876
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
877
+ *
878
+ * The version of the OpenAPI document: 3.0.0
879
+ * Contact: support@kadoa.com
880
+ *
881
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
882
+ * https://openapi-generator.tech
883
+ * Do not edit the class manually.
884
+ */
885
+ interface BulkDeleteRulesResponseData$1 {
886
+ 'deletedCount': number;
887
+ 'workflowId': string;
888
+ 'deletedRuleIds': Array<string>;
603
889
  }
604
- declare const ExtractionSchemaFieldFieldTypeEnum: {
605
- readonly Schema: "SCHEMA";
606
- };
607
- type ExtractionSchemaFieldFieldTypeEnum = typeof ExtractionSchemaFieldFieldTypeEnum[keyof typeof ExtractionSchemaFieldFieldTypeEnum];
608
- declare const ExtractionSchemaFieldDataTypeEnum: {
609
- readonly String: "STRING";
610
- readonly Number: "NUMBER";
611
- readonly Boolean: "BOOLEAN";
612
- readonly Date: "DATE";
613
- readonly Datetime: "DATETIME";
614
- readonly Currency: "CURRENCY";
615
- readonly Money: "MONEY";
616
- readonly Image: "IMAGE";
617
- readonly Link: "LINK";
618
- readonly Object: "OBJECT";
619
- readonly Array: "ARRAY";
620
- readonly JobDescription: "JOB_DESCRIPTION";
621
- readonly CategoryJobTypes: "CATEGORY_JOB_TYPES";
622
- readonly Classification: "CLASSIFICATION";
623
- readonly Categorize: "CATEGORIZE";
624
- readonly StaticScraperData: "STATIC_SCRAPER_DATA";
625
- readonly UniqueId: "UNIQUE_ID";
626
- readonly JobbirdCustom: "JOBBIRD_CUSTOM";
627
- readonly Pass: "PASS";
628
- readonly AdditionalData: "ADDITIONAL_DATA";
629
- };
630
- type ExtractionSchemaFieldDataTypeEnum = typeof ExtractionSchemaFieldDataTypeEnum[keyof typeof ExtractionSchemaFieldDataTypeEnum];
631
890
 
632
891
  /**
633
892
  * Kadoa API
@@ -642,10 +901,13 @@ type ExtractionSchemaFieldDataTypeEnum = typeof ExtractionSchemaFieldDataTypeEnu
642
901
  */
643
902
 
644
903
  /**
645
- * @type SchemaResponseSchemaInner
646
- * Extraction field schema
904
+ * Summary of bulk rule deletion operation with detailed results
647
905
  */
648
- type SchemaResponseSchemaInner = ExtractionClassificationField | ExtractionMetadataField | ExtractionSchemaField;
906
+ interface BulkDeleteRulesResponse {
907
+ 'error': boolean;
908
+ 'message': string;
909
+ 'data': BulkDeleteRulesResponseData$1;
910
+ }
649
911
 
650
912
  /**
651
913
  * Kadoa API
@@ -658,23 +920,30 @@ type SchemaResponseSchemaInner = ExtractionClassificationField | ExtractionMetad
658
920
  * https://openapi-generator.tech
659
921
  * Do not edit the class manually.
660
922
  */
923
+ interface ChangeDetectionRecord {
924
+ 'count': number;
925
+ 'change': number;
926
+ }
661
927
 
662
928
  /**
663
- * Request body for creating a new schema
929
+ * Kadoa API
930
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
931
+ *
932
+ * The version of the OpenAPI document: 3.0.0
933
+ * Contact: support@kadoa.com
934
+ *
935
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
936
+ * https://openapi-generator.tech
937
+ * Do not edit the class manually.
664
938
  */
665
- interface CreateSchemaBody {
666
- /**
667
- * Name of the schema
668
- */
669
- 'name': string;
670
- /**
671
- * Entity type for the schema
672
- */
673
- 'entity'?: string;
674
- /**
675
- * Array of field definitions
676
- */
677
- 'fields': Array<SchemaResponseSchemaInner>;
939
+
940
+ interface ChangeDetectionResultAnomalyCountChanges {
941
+ 'previousJobId': string;
942
+ 'previousValidationId': string;
943
+ 'anomaliesCountTotal': ChangeDetectionRecord;
944
+ 'anomaliesCountByRule': {
945
+ [key: string]: ChangeDetectionRecord;
946
+ };
678
947
  }
679
948
 
680
949
  /**
@@ -688,31 +957,12 @@ interface CreateSchemaBody {
688
957
  * https://openapi-generator.tech
689
958
  * Do not edit the class manually.
690
959
  */
691
- /**
692
- * Browser interaction definition
693
- */
694
- interface Interaction {
695
- /**
696
- * Type of interaction
697
- */
698
- 'type': InteractionTypeEnum;
699
- /**
700
- * CSS selector for the target element
701
- */
702
- 'selector'?: string;
703
- /**
704
- * Text to type (required for TYPE interactions)
705
- */
706
- 'text'?: string;
960
+ interface ChangeDetectionResultStatusCounts {
961
+ 'NEW': number;
962
+ 'ONGOING': number;
963
+ 'RESOLVED': number;
964
+ 'REOPENED'?: number;
707
965
  }
708
- declare const InteractionTypeEnum: {
709
- readonly Click: "CLICK";
710
- readonly Type: "TYPE";
711
- readonly Hover: "HOVER";
712
- readonly Scroll: "SCROLL";
713
- readonly Wait: "WAIT";
714
- };
715
- type InteractionTypeEnum = typeof InteractionTypeEnum[keyof typeof InteractionTypeEnum];
716
966
 
717
967
  /**
718
968
  * Kadoa API
@@ -725,24 +975,21 @@ type InteractionTypeEnum = typeof InteractionTypeEnum[keyof typeof InteractionTy
725
975
  * https://openapi-generator.tech
726
976
  * Do not edit the class manually.
727
977
  */
728
- /**
729
- * Scraping location configuration
730
- */
731
- interface Location {
732
- /**
733
- * Location type
734
- */
735
- 'type': LocationTypeEnum;
978
+
979
+ interface ChangeDetectionResult {
736
980
  /**
737
- * Country ISO code for manual location
981
+ * ISOLATED validates each dataset independently. LINKING_COLUMNS validates data integrity across linked columns between datasets.
738
982
  */
739
- 'isoCode'?: string;
983
+ 'strategy'?: ChangeDetectionResultStrategyEnum;
984
+ 'anomalyCountChanges'?: ChangeDetectionResultAnomalyCountChanges;
985
+ 'anomaliesStatusParquetPath'?: string;
986
+ 'statusCounts'?: ChangeDetectionResultStatusCounts;
740
987
  }
741
- declare const LocationTypeEnum: {
742
- readonly Auto: "auto";
743
- readonly Manual: "manual";
988
+ declare const ChangeDetectionResultStrategyEnum: {
989
+ readonly Isolated: "ISOLATED";
990
+ readonly LinkingColumns: "LINKING_COLUMNS";
744
991
  };
745
- type LocationTypeEnum = typeof LocationTypeEnum[keyof typeof LocationTypeEnum];
992
+ type ChangeDetectionResultStrategyEnum = typeof ChangeDetectionResultStrategyEnum[keyof typeof ChangeDetectionResultStrategyEnum];
746
993
 
747
994
  /**
748
995
  * Kadoa API
@@ -755,25 +1002,10 @@ type LocationTypeEnum = typeof LocationTypeEnum[keyof typeof LocationTypeEnum];
755
1002
  * https://openapi-generator.tech
756
1003
  * Do not edit the class manually.
757
1004
  */
758
- /**
759
- * Field monitoring configuration
760
- */
761
- interface MonitoredField {
762
- /**
763
- * Name of the field to monitor
764
- */
765
- 'fieldName': string;
766
- /**
767
- * Change operator
768
- */
769
- 'operator': MonitoredFieldOperatorEnum;
1005
+ interface CreateRuleParameters {
1006
+ 'sql'?: string;
1007
+ 'params'?: Array<any | null>;
770
1008
  }
771
- declare const MonitoredFieldOperatorEnum: {
772
- readonly Changed: "changed";
773
- readonly Added: "added";
774
- readonly Removed: "removed";
775
- };
776
- type MonitoredFieldOperatorEnum = typeof MonitoredFieldOperatorEnum[keyof typeof MonitoredFieldOperatorEnum];
777
1009
 
778
1010
  /**
779
1011
  * Kadoa API
@@ -788,35 +1020,30 @@ type MonitoredFieldOperatorEnum = typeof MonitoredFieldOperatorEnum[keyof typeof
788
1020
  */
789
1021
 
790
1022
  /**
791
- * Monitoring configuration
1023
+ * Request body for creating a new validation rule
792
1024
  */
793
- interface MonitoringConfig {
794
- /**
795
- * Whether monitoring is enabled
796
- */
797
- 'enabled': boolean;
798
- /**
799
- * Fields to monitor
800
- */
801
- 'fields'?: Array<MonitoredField>;
802
- /**
803
- * Notification channels
804
- */
805
- 'channels'?: Array<any | null>;
806
- /**
807
- * Array of conditions
808
- */
809
- 'conditions'?: Array<null>;
810
- /**
811
- * Logical operator for conditions
812
- */
813
- 'logicalOperator'?: MonitoringConfigLogicalOperatorEnum;
1025
+ interface CreateRule {
1026
+ 'name': string;
1027
+ 'description'?: string;
1028
+ 'ruleType': CreateRuleRuleTypeEnum;
1029
+ 'workflowId'?: string;
1030
+ 'targetColumns'?: Array<string>;
1031
+ 'parameters': CreateRuleParameters;
1032
+ 'status'?: CreateRuleStatusEnum;
1033
+ 'metadata'?: {
1034
+ [key: string]: any | null;
1035
+ };
814
1036
  }
815
- declare const MonitoringConfigLogicalOperatorEnum: {
816
- readonly And: "AND";
817
- readonly Or: "OR";
1037
+ declare const CreateRuleRuleTypeEnum: {
1038
+ readonly CustomSql: "custom_sql";
818
1039
  };
819
- type MonitoringConfigLogicalOperatorEnum = typeof MonitoringConfigLogicalOperatorEnum[keyof typeof MonitoringConfigLogicalOperatorEnum];
1040
+ type CreateRuleRuleTypeEnum = typeof CreateRuleRuleTypeEnum[keyof typeof CreateRuleRuleTypeEnum];
1041
+ declare const CreateRuleStatusEnum: {
1042
+ readonly Preview: "preview";
1043
+ readonly Enabled: "enabled";
1044
+ readonly Disabled: "disabled";
1045
+ };
1046
+ type CreateRuleStatusEnum = typeof CreateRuleStatusEnum[keyof typeof CreateRuleStatusEnum];
820
1047
 
821
1048
  /**
822
1049
  * Kadoa API
@@ -831,101 +1058,22 @@ type MonitoringConfigLogicalOperatorEnum = typeof MonitoringConfigLogicalOperato
831
1058
  */
832
1059
 
833
1060
  /**
834
- * Create an agentic workflow with natural language instructions
1061
+ * Request body for creating a new schema
835
1062
  */
836
- interface CreateWorkflowAgenticBody {
837
- /**
838
- * List of URLs to scrape
839
- */
840
- 'urls': Array<string>;
841
- /**
842
- * Must be agentic-navigation mode
843
- */
844
- 'navigationMode': CreateWorkflowAgenticBodyNavigationModeEnum;
845
- /**
846
- * Name of the workflow
847
- */
848
- 'name'?: string;
849
- /**
850
- * Optional description of the workflow (maximum 500 characters)
851
- */
852
- 'description'?: string;
853
- /**
854
- * Tags for categorization
855
- */
856
- 'tags'?: Array<string>;
857
- /**
858
- * Maximum number of items to scrape
859
- */
860
- 'limit'?: number;
861
- 'location'?: Location;
862
- 'monitoring'?: MonitoringConfig;
863
- /**
864
- * Update frequency
865
- */
866
- 'interval'?: CreateWorkflowAgenticBodyIntervalEnum;
867
- /**
868
- * Cron schedules for updates
869
- */
870
- 'schedules'?: Array<string>;
871
- /**
872
- * When true, bypasses preview and installs the scraper immediately
873
- */
874
- 'bypassPreview'?: boolean;
875
- /**
876
- * Whether to automatically start the workflow after creation
877
- */
878
- 'autoStart'?: boolean;
879
- /**
880
- * Optional browser interactions to perform during scraping
881
- */
882
- 'interactions'?: Array<Interaction>;
883
- /**
884
- * Whether data validation is enabled
885
- */
886
- 'dataValidationEnabled'?: boolean;
887
- /**
888
- * Natural language instructions for the agent (between 10 and 5000 characters)
889
- */
890
- 'userPrompt': string;
1063
+ interface CreateSchemaBody {
891
1064
  /**
892
- * Optional schema ID for agentic workflows
1065
+ * Name of the schema
893
1066
  */
894
- 'schemaId'?: string;
1067
+ 'name': string;
895
1068
  /**
896
- * Optional entity name for agentic workflows
1069
+ * Entity type for the schema
897
1070
  */
898
1071
  'entity'?: string;
899
1072
  /**
900
- * Optional schema fields for agentic workflows
1073
+ * Schema fields for extraction - choose from Data Field (typed data), Raw Content Field (HTML/Markdown), or Classification Field (predefined categories)
901
1074
  */
902
- 'fields'?: Array<SchemaResponseSchemaInner>;
1075
+ 'fields': Array<SchemaResponseSchemaInner>;
903
1076
  }
904
- declare const CreateWorkflowAgenticBodyNavigationModeEnum: {
905
- readonly AgenticNavigation: "agentic-navigation";
906
- };
907
- type CreateWorkflowAgenticBodyNavigationModeEnum = typeof CreateWorkflowAgenticBodyNavigationModeEnum[keyof typeof CreateWorkflowAgenticBodyNavigationModeEnum];
908
- declare const CreateWorkflowAgenticBodyIntervalEnum: {
909
- readonly OnlyOnce: "ONLY_ONCE";
910
- readonly Every10Minutes: "EVERY_10_MINUTES";
911
- readonly HalfHourly: "HALF_HOURLY";
912
- readonly Hourly: "HOURLY";
913
- readonly ThreeHourly: "THREE_HOURLY";
914
- readonly SixHourly: "SIX_HOURLY";
915
- readonly TwelveHourly: "TWELVE_HOURLY";
916
- readonly EighteenHourly: "EIGHTEEN_HOURLY";
917
- readonly Daily: "DAILY";
918
- readonly TwoDay: "TWO_DAY";
919
- readonly ThreeDay: "THREE_DAY";
920
- readonly Weekly: "WEEKLY";
921
- readonly Biweekly: "BIWEEKLY";
922
- readonly Triweekly: "TRIWEEKLY";
923
- readonly FourWeeks: "FOUR_WEEKS";
924
- readonly Monthly: "MONTHLY";
925
- readonly RealTime: "REAL_TIME";
926
- readonly Custom: "CUSTOM";
927
- };
928
- type CreateWorkflowAgenticBodyIntervalEnum = typeof CreateWorkflowAgenticBodyIntervalEnum[keyof typeof CreateWorkflowAgenticBodyIntervalEnum];
929
1077
 
930
1078
  /**
931
1079
  * Kadoa API
@@ -940,76 +1088,80 @@ type CreateWorkflowAgenticBodyIntervalEnum = typeof CreateWorkflowAgenticBodyInt
940
1088
  */
941
1089
 
942
1090
  /**
943
- * Create a workflow by defining entity and fields directly
1091
+ * Create a workflow by defining extraction entity and fields directly in the request. Inline your schema definition to quickly set up custom data extraction without creating a schema separately. Example: `{\"urls\": [\"https://example.com\"], \"entity\": \"Product\", \"fields\": [{\"name\": \"title\", \"description\": \"Product title\", \"fieldType\": \"SCHEMA\", \"dataType\": \"STRING\"}, {\"name\": \"price\", \"description\": \"Product price\", \"fieldType\": \"SCHEMA\", \"dataType\": \"NUMBER\"}]}`
944
1092
  */
945
- interface CreateWorkflowWithCustomSchemaBody {
1093
+ interface WorkflowWithEntityAndFields {
946
1094
  /**
947
- * List of URLs to scrape
1095
+ * List of URLs to scrape. Can be a single URL or multiple URLs to scrape across different pages or domains.
948
1096
  */
949
1097
  'urls': Array<string>;
950
1098
  /**
951
1099
  * Navigation mode for scraping
952
1100
  */
953
- 'navigationMode'?: CreateWorkflowWithCustomSchemaBodyNavigationModeEnum;
1101
+ 'navigationMode'?: WorkflowWithEntityAndFieldsNavigationModeEnum;
954
1102
  /**
955
- * Name of the workflow
1103
+ * Human-readable name for this workflow (e.g., \'Product Catalog Scraper\')
956
1104
  */
957
1105
  'name'?: string;
958
1106
  /**
959
- * Optional description of the workflow (maximum 500 characters)
1107
+ * Detailed description of what this workflow does and why it was created (maximum 500 characters)
960
1108
  */
961
1109
  'description'?: string;
962
1110
  /**
963
- * Tags for categorization
1111
+ * Tags for organizing and categorizing workflows (minimum 3 characters per tag)
964
1112
  */
965
1113
  'tags'?: Array<string>;
966
1114
  /**
967
- * Maximum number of items to scrape
1115
+ * Maximum number of items to scrape. Useful for limiting scope during development or cost control
968
1116
  */
969
1117
  'limit'?: number;
970
1118
  'location'?: Location;
971
1119
  'monitoring'?: MonitoringConfig;
972
1120
  /**
973
- * Update frequency
1121
+ * How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)
974
1122
  */
975
- 'interval'?: CreateWorkflowWithCustomSchemaBodyIntervalEnum;
1123
+ 'interval'?: WorkflowWithEntityAndFieldsIntervalEnum;
976
1124
  /**
977
- * Cron schedules for updates
1125
+ * Cron expressions for custom schedules. Overrides the interval setting for fine-grained control
978
1126
  */
979
1127
  'schedules'?: Array<string>;
980
1128
  /**
981
- * When true, bypasses preview and installs the scraper immediately
1129
+ * Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you\'re confident the configuration is correct
982
1130
  */
983
1131
  'bypassPreview'?: boolean;
984
1132
  /**
985
- * Whether to automatically start the workflow after creation
1133
+ * Automatically start the workflow after creation. Set to false if you want to test/review before starting
986
1134
  */
987
1135
  'autoStart'?: boolean;
988
1136
  /**
989
- * Optional browser interactions to perform during scraping
1137
+ * Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types
990
1138
  */
991
1139
  'interactions'?: Array<Interaction>;
992
1140
  /**
993
- * Whether data validation is enabled
1141
+ * Enable data quality validation. When true, scraped data is validated against the schema and anomalies are detected
994
1142
  */
995
1143
  'dataValidationEnabled'?: boolean;
996
1144
  /**
997
- * Entity name for extraction
1145
+ * Additional static data for the workflow
998
1146
  */
999
- 'entity'?: string;
1147
+ 'additionalData'?: object;
1148
+ /**
1149
+ * Entity name for extraction (e.g., \'Product\', \'JobListing\')
1150
+ */
1151
+ 'schemaId'?: string;
1000
1152
  /**
1001
- * Schema fields for extraction
1153
+ * Array of fields to extract from each item. Each field defines a property to capture (e.g., title, price, description)
1002
1154
  */
1003
1155
  'fields': Array<SchemaResponseSchemaInner>;
1004
1156
  }
1005
- declare const CreateWorkflowWithCustomSchemaBodyNavigationModeEnum: {
1157
+ declare const WorkflowWithEntityAndFieldsNavigationModeEnum: {
1006
1158
  readonly SinglePage: "single-page";
1007
1159
  readonly PaginatedPage: "paginated-page";
1008
1160
  readonly PageAndDetail: "page-and-detail";
1009
1161
  readonly AgenticNavigation: "agentic-navigation";
1010
1162
  };
1011
- type CreateWorkflowWithCustomSchemaBodyNavigationModeEnum = typeof CreateWorkflowWithCustomSchemaBodyNavigationModeEnum[keyof typeof CreateWorkflowWithCustomSchemaBodyNavigationModeEnum];
1012
- declare const CreateWorkflowWithCustomSchemaBodyIntervalEnum: {
1163
+ type WorkflowWithEntityAndFieldsNavigationModeEnum = typeof WorkflowWithEntityAndFieldsNavigationModeEnum[keyof typeof WorkflowWithEntityAndFieldsNavigationModeEnum];
1164
+ declare const WorkflowWithEntityAndFieldsIntervalEnum: {
1013
1165
  readonly OnlyOnce: "ONLY_ONCE";
1014
1166
  readonly Every10Minutes: "EVERY_10_MINUTES";
1015
1167
  readonly HalfHourly: "HALF_HOURLY";
@@ -1029,7 +1181,7 @@ declare const CreateWorkflowWithCustomSchemaBodyIntervalEnum: {
1029
1181
  readonly RealTime: "REAL_TIME";
1030
1182
  readonly Custom: "CUSTOM";
1031
1183
  };
1032
- type CreateWorkflowWithCustomSchemaBodyIntervalEnum = typeof CreateWorkflowWithCustomSchemaBodyIntervalEnum[keyof typeof CreateWorkflowWithCustomSchemaBodyIntervalEnum];
1184
+ type WorkflowWithEntityAndFieldsIntervalEnum = typeof WorkflowWithEntityAndFieldsIntervalEnum[keyof typeof WorkflowWithEntityAndFieldsIntervalEnum];
1033
1185
 
1034
1186
  /**
1035
1187
  * Kadoa API
@@ -1044,72 +1196,80 @@ type CreateWorkflowWithCustomSchemaBodyIntervalEnum = typeof CreateWorkflowWithC
1044
1196
  */
1045
1197
 
1046
1198
  /**
1047
- * Create a workflow using an existing schema configuration
1199
+ * Create a workflow using a pre-defined schema configuration. Reference an existing schema by ID to extract data without re-defining fields. Perfect when you have multiple workflows using the same data structure. Example: `{\"urls\": [\"https://example.com\"], \"schemaId\": \"schema-abc123\", \"interval\": \"DAILY\"}`
1048
1200
  */
1049
- interface CreateWorkflowWithSchemaBody {
1201
+ interface WorkflowWithExistingSchema {
1050
1202
  /**
1051
- * List of URLs to scrape
1203
+ * List of URLs to scrape. Can be a single URL or multiple URLs to scrape across different pages or domains.
1052
1204
  */
1053
1205
  'urls': Array<string>;
1054
1206
  /**
1055
1207
  * Navigation mode for scraping
1056
1208
  */
1057
- 'navigationMode'?: CreateWorkflowWithSchemaBodyNavigationModeEnum;
1209
+ 'navigationMode'?: WorkflowWithExistingSchemaNavigationModeEnum;
1058
1210
  /**
1059
- * Name of the workflow
1211
+ * Human-readable name for this workflow (e.g., \'Product Catalog Scraper\')
1060
1212
  */
1061
1213
  'name'?: string;
1062
1214
  /**
1063
- * Optional description of the workflow (maximum 500 characters)
1215
+ * Detailed description of what this workflow does and why it was created (maximum 500 characters)
1064
1216
  */
1065
1217
  'description'?: string;
1066
1218
  /**
1067
- * Tags for categorization
1219
+ * Tags for organizing and categorizing workflows (minimum 3 characters per tag)
1068
1220
  */
1069
1221
  'tags'?: Array<string>;
1070
1222
  /**
1071
- * Maximum number of items to scrape
1223
+ * Maximum number of items to scrape. Useful for limiting scope during development or cost control
1072
1224
  */
1073
1225
  'limit'?: number;
1074
1226
  'location'?: Location;
1075
1227
  'monitoring'?: MonitoringConfig;
1076
1228
  /**
1077
- * Update frequency
1229
+ * How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)
1078
1230
  */
1079
- 'interval'?: CreateWorkflowWithSchemaBodyIntervalEnum;
1231
+ 'interval'?: WorkflowWithExistingSchemaIntervalEnum;
1080
1232
  /**
1081
- * Cron schedules for updates
1233
+ * Cron expressions for custom schedules. Overrides the interval setting for fine-grained control
1082
1234
  */
1083
1235
  'schedules'?: Array<string>;
1084
1236
  /**
1085
- * When true, bypasses preview and installs the scraper immediately
1237
+ * Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you\'re confident the configuration is correct
1086
1238
  */
1087
1239
  'bypassPreview'?: boolean;
1088
1240
  /**
1089
- * Whether to automatically start the workflow after creation
1241
+ * Automatically start the workflow after creation. Set to false if you want to test/review before starting
1090
1242
  */
1091
1243
  'autoStart'?: boolean;
1092
1244
  /**
1093
- * Optional browser interactions to perform during scraping
1245
+ * Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types
1094
1246
  */
1095
1247
  'interactions'?: Array<Interaction>;
1096
1248
  /**
1097
- * Whether data validation is enabled
1249
+ * Enable data quality validation. When true, scraped data is validated against the schema and anomalies are detected
1250
+ */
1251
+ 'dataValidationEnabled'?: boolean;
1252
+ /**
1253
+ * Additional static data for the workflow
1254
+ */
1255
+ 'additionalData'?: object;
1256
+ /**
1257
+ * Entity name for extraction
1098
1258
  */
1099
- 'dataValidationEnabled'?: boolean;
1259
+ 'entity'?: string;
1100
1260
  /**
1101
- * ID of existing schema configuration
1261
+ * ID of an existing schema configuration. Use this to reference a previously defined schema without re-defining extraction fields
1102
1262
  */
1103
1263
  'schemaId': string;
1104
1264
  }
1105
- declare const CreateWorkflowWithSchemaBodyNavigationModeEnum: {
1265
+ declare const WorkflowWithExistingSchemaNavigationModeEnum: {
1106
1266
  readonly SinglePage: "single-page";
1107
1267
  readonly PaginatedPage: "paginated-page";
1108
1268
  readonly PageAndDetail: "page-and-detail";
1109
1269
  readonly AgenticNavigation: "agentic-navigation";
1110
1270
  };
1111
- type CreateWorkflowWithSchemaBodyNavigationModeEnum = typeof CreateWorkflowWithSchemaBodyNavigationModeEnum[keyof typeof CreateWorkflowWithSchemaBodyNavigationModeEnum];
1112
- declare const CreateWorkflowWithSchemaBodyIntervalEnum: {
1271
+ type WorkflowWithExistingSchemaNavigationModeEnum = typeof WorkflowWithExistingSchemaNavigationModeEnum[keyof typeof WorkflowWithExistingSchemaNavigationModeEnum];
1272
+ declare const WorkflowWithExistingSchemaIntervalEnum: {
1113
1273
  readonly OnlyOnce: "ONLY_ONCE";
1114
1274
  readonly Every10Minutes: "EVERY_10_MINUTES";
1115
1275
  readonly HalfHourly: "HALF_HOURLY";
@@ -1129,7 +1289,7 @@ declare const CreateWorkflowWithSchemaBodyIntervalEnum: {
1129
1289
  readonly RealTime: "REAL_TIME";
1130
1290
  readonly Custom: "CUSTOM";
1131
1291
  };
1132
- type CreateWorkflowWithSchemaBodyIntervalEnum = typeof CreateWorkflowWithSchemaBodyIntervalEnum[keyof typeof CreateWorkflowWithSchemaBodyIntervalEnum];
1292
+ type WorkflowWithExistingSchemaIntervalEnum = typeof WorkflowWithExistingSchemaIntervalEnum[keyof typeof WorkflowWithExistingSchemaIntervalEnum];
1133
1293
 
1134
1294
  /**
1135
1295
  * Kadoa API
@@ -1147,7 +1307,7 @@ type CreateWorkflowWithSchemaBodyIntervalEnum = typeof CreateWorkflowWithSchemaB
1147
1307
  * @type CreateWorkflowBody
1148
1308
  * Request body for creating a new workflow
1149
1309
  */
1150
- type CreateWorkflowBody = CreateWorkflowAgenticBody | CreateWorkflowWithCustomSchemaBody | CreateWorkflowWithSchemaBody;
1310
+ type CreateWorkflowBody = AgenticWorkflow | WorkflowWithEntityAndFields | WorkflowWithExistingSchema;
1151
1311
 
1152
1312
  /**
1153
1313
  * Kadoa API
@@ -1726,10 +1886,6 @@ interface SchemaResponse$1 {
1726
1886
  * Name of the schema
1727
1887
  */
1728
1888
  'name': string;
1729
- /**
1730
- * Schema type (always NEO)
1731
- */
1732
- 'type': SchemaResponseTypeEnum;
1733
1889
  /**
1734
1890
  * Whether the schema is public
1735
1891
  */
@@ -1744,10 +1900,6 @@ interface SchemaResponse$1 {
1744
1900
  'entity': string | null;
1745
1901
  'description': SchemaResponseDescription;
1746
1902
  }
1747
- declare const SchemaResponseTypeEnum: {
1748
- readonly Neo: "NEO";
1749
- };
1750
- type SchemaResponseTypeEnum = typeof SchemaResponseTypeEnum[keyof typeof SchemaResponseTypeEnum];
1751
1903
 
1752
1904
  /**
1753
1905
  * Kadoa API
@@ -2378,7 +2530,7 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2378
2530
  /**
2379
2531
  * Unique identifier for the workflow
2380
2532
  */
2381
- '_id'?: string;
2533
+ 'id'?: string;
2382
2534
  /**
2383
2535
  * Name of the workflow
2384
2536
  */
@@ -2411,6 +2563,10 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2411
2563
  * Maximum number of items to scrape
2412
2564
  */
2413
2565
  'limit'?: number;
2566
+ /**
2567
+ * Additional static data for the workflow
2568
+ */
2569
+ 'additionalData'?: object;
2414
2570
  /**
2415
2571
  * When the last job finished
2416
2572
  */
@@ -2456,10 +2612,6 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2456
2612
  * Extraction schema fields
2457
2613
  */
2458
2614
  'schema'?: Array<V4WorkflowsWorkflowIdGet200ResponseSchemaInner>;
2459
- /**
2460
- * Type of schema (deprecated)
2461
- */
2462
- 'schemaType'?: V4WorkflowsGet200ResponseWorkflowsInnerSchemaTypeEnum;
2463
2615
  /**
2464
2616
  * Name of the template used
2465
2617
  */
@@ -2468,10 +2620,6 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2468
2620
  * ID of the template used
2469
2621
  */
2470
2622
  'templateId'?: string;
2471
- /**
2472
- * Whether the schema can be edited
2473
- */
2474
- 'isSchemaEditable'?: boolean;
2475
2623
  /**
2476
2624
  * Errors from the last job run
2477
2625
  */
@@ -2511,11 +2659,6 @@ declare const V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum: {
2511
2659
  readonly Failed: "FAILED";
2512
2660
  };
2513
2661
  type V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum = typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum[keyof typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum];
2514
- declare const V4WorkflowsGet200ResponseWorkflowsInnerSchemaTypeEnum: {
2515
- readonly Detail: "DETAIL";
2516
- readonly Directory: "DIRECTORY";
2517
- };
2518
- type V4WorkflowsGet200ResponseWorkflowsInnerSchemaTypeEnum = typeof V4WorkflowsGet200ResponseWorkflowsInnerSchemaTypeEnum[keyof typeof V4WorkflowsGet200ResponseWorkflowsInnerSchemaTypeEnum];
2519
2662
 
2520
2663
  /**
2521
2664
  * Kadoa API
@@ -2891,7 +3034,7 @@ interface V4WorkflowsWorkflowIdGet200Response {
2891
3034
  /**
2892
3035
  * Unique identifier for the workflow
2893
3036
  */
2894
- '_id'?: string;
3037
+ 'id'?: string;
2895
3038
  /**
2896
3039
  * Name of the workflow
2897
3040
  */
@@ -2993,10 +3136,6 @@ interface V4WorkflowsWorkflowIdGet200Response {
2993
3136
  * Extraction schema fields
2994
3137
  */
2995
3138
  'schema'?: Array<V4WorkflowsWorkflowIdGet200ResponseSchemaInner>;
2996
- /**
2997
- * Type of schema (deprecated)
2998
- */
2999
- 'schemaType'?: V4WorkflowsWorkflowIdGet200ResponseSchemaTypeEnum;
3000
3139
  /**
3001
3140
  * Entity information
3002
3141
  */
@@ -3048,11 +3187,6 @@ declare const V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum: {
3048
3187
  readonly Running: "RUNNING";
3049
3188
  };
3050
3189
  type V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum = typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum];
3051
- declare const V4WorkflowsWorkflowIdGet200ResponseSchemaTypeEnum: {
3052
- readonly Detail: "DETAIL";
3053
- readonly Directory: "DIRECTORY";
3054
- };
3055
- type V4WorkflowsWorkflowIdGet200ResponseSchemaTypeEnum = typeof V4WorkflowsWorkflowIdGet200ResponseSchemaTypeEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseSchemaTypeEnum];
3056
3190
 
3057
3191
  /**
3058
3192
  * Kadoa API
@@ -4256,228 +4390,6 @@ interface V5NotificationsTestPostRequest {
4256
4390
  'workflowId'?: string;
4257
4391
  }
4258
4392
 
4259
- /**
4260
- * Kadoa API
4261
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4262
- *
4263
- * The version of the OpenAPI document: 3.0.0
4264
- * Contact: support@kadoa.com
4265
- *
4266
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4267
- * https://openapi-generator.tech
4268
- * Do not edit the class manually.
4269
- */
4270
- interface V5WorkflowsIdGet200ResponseWorkflowTagsInner {
4271
- /**
4272
- * The ID of the tag
4273
- */
4274
- 'id'?: string;
4275
- /**
4276
- * The name of the tag
4277
- */
4278
- 'name'?: string;
4279
- /**
4280
- * The description of the tag
4281
- */
4282
- 'description'?: string;
4283
- }
4284
-
4285
- /**
4286
- * Kadoa API
4287
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4288
- *
4289
- * The version of the OpenAPI document: 3.0.0
4290
- * Contact: support@kadoa.com
4291
- *
4292
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4293
- * https://openapi-generator.tech
4294
- * Do not edit the class manually.
4295
- */
4296
-
4297
- interface V5WorkflowsIdGet200Response {
4298
- /**
4299
- * The ID of the workflow
4300
- */
4301
- 'id'?: string;
4302
- /**
4303
- * The current state of the workflow
4304
- */
4305
- 'state'?: string;
4306
- /**
4307
- * The name of the workflow
4308
- */
4309
- 'name'?: string;
4310
- /**
4311
- * The description of the workflow
4312
- */
4313
- 'description'?: string;
4314
- /**
4315
- * Maximum number of records to process
4316
- */
4317
- 'recordsLimit'?: number;
4318
- 'workflowTags'?: Array<V5WorkflowsIdGet200ResponseWorkflowTagsInner>;
4319
- /**
4320
- * Timestamp when the workflow was created
4321
- */
4322
- 'createdAt'?: string;
4323
- /**
4324
- * Timestamp when the workflow was last updated
4325
- */
4326
- 'updatedAt'?: string;
4327
- }
4328
-
4329
- /**
4330
- * Kadoa API
4331
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4332
- *
4333
- * The version of the OpenAPI document: 3.0.0
4334
- * Contact: support@kadoa.com
4335
- *
4336
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4337
- * https://openapi-generator.tech
4338
- * Do not edit the class manually.
4339
- */
4340
- interface V5WorkflowsIdPut200ResponseWorkflowTagsInner {
4341
- 'id'?: string;
4342
- 'name'?: string;
4343
- 'description'?: string;
4344
- }
4345
-
4346
- /**
4347
- * Kadoa API
4348
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4349
- *
4350
- * The version of the OpenAPI document: 3.0.0
4351
- * Contact: support@kadoa.com
4352
- *
4353
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4354
- * https://openapi-generator.tech
4355
- * Do not edit the class manually.
4356
- */
4357
-
4358
- interface V5WorkflowsIdPut200Response {
4359
- 'id'?: string;
4360
- 'name'?: string;
4361
- 'description'?: string;
4362
- 'state'?: string;
4363
- 'recordLimit'?: number;
4364
- 'workflowTags'?: Array<V5WorkflowsIdPut200ResponseWorkflowTagsInner>;
4365
- 'createdAt'?: string;
4366
- 'updatedAt'?: string;
4367
- }
4368
-
4369
- /**
4370
- * Kadoa API
4371
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4372
- *
4373
- * The version of the OpenAPI document: 3.0.0
4374
- * Contact: support@kadoa.com
4375
- *
4376
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4377
- * https://openapi-generator.tech
4378
- * Do not edit the class manually.
4379
- */
4380
- interface V5WorkflowsIdPutRequest {
4381
- /**
4382
- * New name for the workflow
4383
- */
4384
- 'name'?: string;
4385
- /**
4386
- * New description for the workflow
4387
- */
4388
- 'description'?: string;
4389
- /**
4390
- * Array of tag IDs to associate with the workflow
4391
- */
4392
- 'workflowTags'?: Array<string>;
4393
- /**
4394
- * Maximum number of records to process
4395
- */
4396
- 'recordLimit'?: number;
4397
- /**
4398
- * New state for the workflow
4399
- */
4400
- 'state'?: V5WorkflowsIdPutRequestStateEnum;
4401
- }
4402
- declare const V5WorkflowsIdPutRequestStateEnum: {
4403
- readonly Active: "active";
4404
- readonly Inactive: "inactive";
4405
- readonly Archived: "archived";
4406
- };
4407
- type V5WorkflowsIdPutRequestStateEnum = typeof V5WorkflowsIdPutRequestStateEnum[keyof typeof V5WorkflowsIdPutRequestStateEnum];
4408
-
4409
- /**
4410
- * Kadoa API
4411
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4412
- *
4413
- * The version of the OpenAPI document: 3.0.0
4414
- * Contact: support@kadoa.com
4415
- *
4416
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4417
- * https://openapi-generator.tech
4418
- * Do not edit the class manually.
4419
- */
4420
- interface V5WorkflowsPost201Response {
4421
- /**
4422
- * The ID of the created workflow
4423
- */
4424
- 'id'?: string;
4425
- /**
4426
- * The name of the created workflow
4427
- */
4428
- 'name'?: string;
4429
- /**
4430
- * The description of the created workflow
4431
- */
4432
- 'description'?: string;
4433
- /**
4434
- * The state of the created workflow
4435
- */
4436
- 'state'?: string;
4437
- /**
4438
- * Maximum number of records to process
4439
- */
4440
- 'recordLimit'?: number;
4441
- /**
4442
- * Timestamp when the workflow was created
4443
- */
4444
- 'createdAt'?: string;
4445
- /**
4446
- * Timestamp when the workflow was last updated
4447
- */
4448
- 'updatedAt'?: string;
4449
- }
4450
-
4451
- /**
4452
- * Kadoa API
4453
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4454
- *
4455
- * The version of the OpenAPI document: 3.0.0
4456
- * Contact: support@kadoa.com
4457
- *
4458
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4459
- * https://openapi-generator.tech
4460
- * Do not edit the class manually.
4461
- */
4462
- interface V5WorkflowsPostRequest {
4463
- /**
4464
- * Name of the workflow
4465
- */
4466
- 'name': string;
4467
- /**
4468
- * Optional description of the workflow
4469
- */
4470
- 'description'?: string;
4471
- /**
4472
- * Array of tag IDs to associate with the workflow
4473
- */
4474
- 'workflowTags'?: Array<string>;
4475
- /**
4476
- * Maximum number of records to process
4477
- */
4478
- 'recordLimit'?: number;
4479
- }
4480
-
4481
4393
  /**
4482
4394
  * Kadoa API
4483
4395
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4994,38 +4906,6 @@ interface WorkflowsApiInterface {
4994
4906
  * @throws {RequiredError}
4995
4907
  */
4996
4908
  v5ChangesGet(requestParameters?: WorkflowsApiV5ChangesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V4ChangesGet200Response>;
4997
- /**
4998
- * Permanently deletes a workflow and its associated tags
4999
- * @summary Delete a workflow
5000
- * @param {WorkflowsApiV5WorkflowsIdDeleteRequest} requestParameters Request parameters.
5001
- * @param {*} [options] Override http request option.
5002
- * @throws {RequiredError}
5003
- */
5004
- v5WorkflowsIdDelete(requestParameters: WorkflowsApiV5WorkflowsIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5005
- /**
5006
- * Retrieves a specific workflow and its associated tags by ID
5007
- * @summary Get workflow by ID
5008
- * @param {WorkflowsApiV5WorkflowsIdGetRequest} requestParameters Request parameters.
5009
- * @param {*} [options] Override http request option.
5010
- * @throws {RequiredError}
5011
- */
5012
- v5WorkflowsIdGet(requestParameters: WorkflowsApiV5WorkflowsIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V5WorkflowsIdGet200Response>;
5013
- /**
5014
- * Updates an existing workflow\'s properties
5015
- * @summary Update a workflow
5016
- * @param {WorkflowsApiV5WorkflowsIdPutRequest} requestParameters Request parameters.
5017
- * @param {*} [options] Override http request option.
5018
- * @throws {RequiredError}
5019
- */
5020
- v5WorkflowsIdPut(requestParameters: WorkflowsApiV5WorkflowsIdPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<V5WorkflowsIdPut200Response>;
5021
- /**
5022
- * Creates a new workflow in pending state
5023
- * @summary Create a new workflow
5024
- * @param {WorkflowsApiV5WorkflowsPostRequest} requestParameters Request parameters.
5025
- * @param {*} [options] Override http request option.
5026
- * @throws {RequiredError}
5027
- */
5028
- v5WorkflowsPost(requestParameters: WorkflowsApiV5WorkflowsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<V5WorkflowsPost201Response>;
5029
4909
  /**
5030
4910
  *
5031
4911
  * @summary Get workflow audit log entries
@@ -5121,6 +5001,10 @@ interface WorkflowsApiV4WorkflowsGetRequest {
5121
5001
  * Filter workflows by template ID (DEPRECATED - templates replaced by schemas)
5122
5002
  */
5123
5003
  readonly templateId?: string;
5004
+ /**
5005
+ * Filter workflows by user ID (only works in team context)
5006
+ */
5007
+ readonly userId?: string;
5124
5008
  /**
5125
5009
  * Include deleted workflows (for compliance officers)
5126
5010
  */
@@ -5397,40 +5281,6 @@ interface WorkflowsApiV5ChangesGetRequest {
5397
5281
  */
5398
5282
  readonly limit?: number;
5399
5283
  }
5400
- /**
5401
- * Request parameters for v5WorkflowsIdDelete operation in WorkflowsApi.
5402
- */
5403
- interface WorkflowsApiV5WorkflowsIdDeleteRequest {
5404
- /**
5405
- * The ID of the workflow to delete
5406
- */
5407
- readonly id: string;
5408
- }
5409
- /**
5410
- * Request parameters for v5WorkflowsIdGet operation in WorkflowsApi.
5411
- */
5412
- interface WorkflowsApiV5WorkflowsIdGetRequest {
5413
- /**
5414
- * The ID of the workflow to retrieve
5415
- */
5416
- readonly id: string;
5417
- }
5418
- /**
5419
- * Request parameters for v5WorkflowsIdPut operation in WorkflowsApi.
5420
- */
5421
- interface WorkflowsApiV5WorkflowsIdPutRequest {
5422
- /**
5423
- * The ID of the workflow to update
5424
- */
5425
- readonly id: string;
5426
- readonly v5WorkflowsIdPutRequest: V5WorkflowsIdPutRequest;
5427
- }
5428
- /**
5429
- * Request parameters for v5WorkflowsPost operation in WorkflowsApi.
5430
- */
5431
- interface WorkflowsApiV5WorkflowsPostRequest {
5432
- readonly v5WorkflowsPostRequest: V5WorkflowsPostRequest;
5433
- }
5434
5284
  /**
5435
5285
  * Request parameters for v5WorkflowsWorkflowIdAuditlogGet operation in WorkflowsApi.
5436
5286
  */
@@ -5602,22 +5452,24 @@ declare class ListWorkflowsRequest implements WorkflowsApiV4WorkflowsGetRequest
5602
5452
  includeDeleted?: IncludeDeleted;
5603
5453
  format?: ResponseFormat;
5604
5454
  }
5605
- type CreateWorkflowRequest = CreateWorkflowWithSchemaBody;
5606
- type CreateWorkflowWithCustomSchemaRequest = CreateWorkflowWithCustomSchemaBody;
5455
+ type CreateWorkflowRequest = WorkflowWithExistingSchema;
5456
+ type CreateWorkflowWithCustomSchemaRequest = WorkflowWithEntityAndFields;
5607
5457
  /**
5608
5458
  * Workflow response with SDK-curated enum types.
5609
5459
  * Remaps generated enum fields to prevent type leakage.
5610
5460
  */
5611
- interface WorkflowResponse extends Omit<V4WorkflowsGet200ResponseWorkflowsInner, "state" | "displayState"> {
5461
+ interface WorkflowResponse extends Omit<V4WorkflowsGet200ResponseWorkflowsInner, "state" | "displayState" | "additionalData"> {
5612
5462
  state?: WorkflowStateEnum;
5613
5463
  displayState?: WorkflowDisplayStateEnum;
5464
+ additionalData?: Record<string, unknown>;
5614
5465
  }
5615
5466
  /**
5616
5467
  * Get workflow details response with SDK-curated enum types.
5617
5468
  */
5618
- interface GetWorkflowResponse extends Omit<V4WorkflowsWorkflowIdGet200Response, "state" | "displayState"> {
5469
+ interface GetWorkflowResponse extends Omit<V4WorkflowsWorkflowIdGet200Response, "state" | "displayState" | "additionalData"> {
5619
5470
  state?: WorkflowStateEnum;
5620
5471
  displayState?: WorkflowDisplayStateEnum;
5472
+ additionalData?: Record<string, unknown>;
5621
5473
  }
5622
5474
 
5623
5475
  /**
@@ -5628,6 +5480,8 @@ interface GetJobResponse extends Omit<V4WorkflowsWorkflowIdJobsJobIdGet200Respon
5628
5480
  }
5629
5481
  type RunWorkflowRequest = V4WorkflowsWorkflowIdRunPutRequest;
5630
5482
  type RunWorkflowResponse = V4WorkflowsWorkflowIdRunPut200Response;
5483
+ type UpdateWorkflowRequest = V4WorkflowsWorkflowIdMetadataPutRequest;
5484
+ type UpdateWorkflowResponse = V4WorkflowsWorkflowIdMetadataPut200Response;
5631
5485
 
5632
5486
  /**
5633
5487
  * Extraction domain ACL.
@@ -5667,36 +5521,39 @@ declare class FetchDataOptions {
5667
5521
  includeAnomalies?: boolean;
5668
5522
  }
5669
5523
  /**
5670
- * Schema field data type enum.
5524
+ * Curated field data type enum exposed by the SDK.
5525
+ * Includes aliases for the legacy TEXT/URL identifiers for backwards compatibility.
5671
5526
  */
5672
5527
  declare const SchemaFieldDataType: {
5673
- readonly Text: "TEXT";
5528
+ /** @deprecated use `SchemaFieldDataType.String` */
5529
+ readonly Text: "STRING";
5530
+ /** @deprecated use `SchemaFieldDataType.Link` */
5531
+ readonly Url: "LINK";
5532
+ readonly String: "STRING";
5674
5533
  readonly Number: "NUMBER";
5534
+ readonly Boolean: "BOOLEAN";
5675
5535
  readonly Date: "DATE";
5676
- readonly Url: "URL";
5677
- readonly Email: "EMAIL";
5536
+ readonly Datetime: "DATETIME";
5537
+ readonly Money: "MONEY";
5678
5538
  readonly Image: "IMAGE";
5679
- readonly Video: "VIDEO";
5680
- readonly Phone: "PHONE";
5681
- readonly Boolean: "BOOLEAN";
5682
- readonly Location: "LOCATION";
5683
- readonly Array: "ARRAY";
5539
+ readonly Link: "LINK";
5684
5540
  readonly Object: "OBJECT";
5541
+ readonly Array: "ARRAY";
5685
5542
  };
5686
5543
  type SchemaFieldDataType = (typeof SchemaFieldDataType)[keyof typeof SchemaFieldDataType];
5687
- type SchemaField$1 = ExtractionSchemaField | ExtractionClassificationField | ExtractionMetadataField;
5688
- type NavigationMode = (typeof CreateWorkflowWithSchemaBodyNavigationModeEnum)[keyof typeof CreateWorkflowWithSchemaBodyNavigationModeEnum];
5689
- type DataTypeInternal = (typeof ExtractionSchemaFieldDataTypeEnum)[keyof typeof ExtractionSchemaFieldDataTypeEnum];
5544
+ type SchemaField$1 = DataField | ClassificationField | RawContentField;
5545
+ type NavigationMode = (typeof WorkflowWithExistingSchemaNavigationModeEnum)[keyof typeof WorkflowWithExistingSchemaNavigationModeEnum];
5546
+ type DataTypeInternal = (typeof DataFieldDataTypeEnum)[keyof typeof DataFieldDataTypeEnum];
5690
5547
  type DataType = Exclude<DataTypeInternal, "CURRENCY" | "JOB_DESCRIPTION" | "CATEGORY_JOB_TYPES" | "CLASSIFICATION" | "CATEGORIZE" | "STATIC_SCRAPER_DATA" | "UNIQUE_ID" | "JOBBIRD_CUSTOM" | "PASS" | "ADDITIONAL_DATA">;
5691
- type MetadataKey = (typeof ExtractionMetadataFieldMetadataKeyEnum)[keyof typeof ExtractionMetadataFieldMetadataKeyEnum];
5692
- type WorkflowInterval = (typeof CreateWorkflowWithSchemaBodyIntervalEnum)[keyof typeof CreateWorkflowWithSchemaBodyIntervalEnum];
5548
+ type MetadataKey = (typeof RawContentFieldMetadataKeyEnum)[keyof typeof RawContentFieldMetadataKeyEnum];
5549
+ type WorkflowInterval = (typeof WorkflowWithExistingSchemaIntervalEnum)[keyof typeof WorkflowWithExistingSchemaIntervalEnum];
5693
5550
  type MonitoringOperator = (typeof V4WorkflowsWorkflowIdMetadataPutRequestMonitoringFieldsInnerOperatorEnum)[keyof typeof V4WorkflowsWorkflowIdMetadataPutRequestMonitoringFieldsInnerOperatorEnum];
5694
5551
  type MonitoringField = V4WorkflowsWorkflowIdMetadataPutRequestMonitoringFieldsInner & {
5695
5552
  isKeyField?: boolean;
5696
5553
  };
5697
5554
  type LocationConfig = Location;
5698
- type RawFormat = (typeof ExtractionMetadataFieldMetadataKeyEnum)[keyof typeof ExtractionMetadataFieldMetadataKeyEnum];
5699
- type FieldType = ExtractionMetadataFieldFieldTypeEnum | ExtractionClassificationFieldFieldTypeEnum | ExtractionSchemaFieldFieldTypeEnum;
5555
+ type RawFormat = (typeof RawContentFieldMetadataKeyEnum)[keyof typeof RawContentFieldMetadataKeyEnum];
5556
+ type FieldType = RawContentFieldFieldTypeEnum | ClassificationFieldFieldTypeEnum | DataFieldFieldTypeEnum;
5700
5557
  type WorkflowMonitoringConfig = MonitoringConfig;
5701
5558
  /**
5702
5559
  * Workflow details response.
@@ -6027,6 +5884,12 @@ interface PollingResult<T> {
6027
5884
  */
6028
5885
  declare function pollUntil<T>(pollFn: () => Promise<T>, isComplete: (result: T) => boolean, options?: PollingOptions): Promise<PollingResult<T>>;
6029
5886
 
5887
+ /**
5888
+ * Validate the additionalData payload accepted by workflow creation and update APIs.
5889
+ * Ensures the value is a plain JSON-serializable object and warns if large.
5890
+ */
5891
+ declare function validateAdditionalData(additionalData: unknown): void;
5892
+
6030
5893
  type WorkflowId = string;
6031
5894
  type JobId = string;
6032
5895
  interface WaitOptions extends PollingOptions {
@@ -6050,6 +5913,7 @@ interface CreateWorkflowInput {
6050
5913
  bypassPreview?: boolean;
6051
5914
  autoStart?: boolean;
6052
5915
  schedules?: string[];
5916
+ additionalData?: Record<string, unknown>;
6053
5917
  }
6054
5918
  declare class WorkflowsCoreService {
6055
5919
  private readonly workflowsApi;
@@ -6060,7 +5924,12 @@ declare class WorkflowsCoreService {
6060
5924
  get(id: WorkflowId): Promise<GetWorkflowResponse>;
6061
5925
  list(filters?: ListWorkflowsRequest): Promise<WorkflowResponse[]>;
6062
5926
  getByName(name: string): Promise<WorkflowResponse | undefined>;
5927
+ /**
5928
+ * @deprecated Use delete(id) instead.
5929
+ */
6063
5930
  cancel(id: WorkflowId): Promise<void>;
5931
+ delete(id: WorkflowId): Promise<void>;
5932
+ update(id: WorkflowId, input: UpdateWorkflowRequest): Promise<UpdateWorkflowResponse>;
6064
5933
  resume(id: WorkflowId): Promise<void>;
6065
5934
  /**
6066
5935
  * Wait for a workflow to reach the target state or a terminal state if no target state is provided
@@ -6097,6 +5966,7 @@ interface ExtractionOptionsInternal {
6097
5966
  tags?: string[];
6098
5967
  notifications?: NotificationOptions;
6099
5968
  autoStart?: boolean;
5969
+ additionalData?: Record<string, unknown>;
6100
5970
  }
6101
5971
  type ExtractionOptions = {
6102
5972
  urls: string[];
@@ -6210,14 +6080,14 @@ type SchemaResponse = SchemaResponse$1;
6210
6080
  type SchemaField = SchemaResponseSchemaInner;
6211
6081
  /**
6212
6082
  * Example value for a field.
6213
- * Re-exported from generated ExtractionSchemaFieldExample model.
6083
+ * Re-exported from generated DataFieldExample model.
6214
6084
  */
6215
- type FieldExample = ExtractionSchemaFieldExample;
6085
+ type FieldExample = DataFieldExample;
6216
6086
  /**
6217
6087
  * Category definition for classification fields.
6218
- * Re-exported from generated ExtractionClassificationFieldCategoriesInner model.
6088
+ * Re-exported from generated ClassificationFieldCategoriesInner model.
6219
6089
  */
6220
- type Category = ExtractionClassificationFieldCategoriesInner;
6090
+ type Category = ClassificationFieldCategoriesInner;
6221
6091
 
6222
6092
  /**
6223
6093
  * Optional configuration for schema fields
@@ -6280,6 +6150,7 @@ interface ExtractOptionsInternal {
6280
6150
  interval?: WorkflowInterval;
6281
6151
  schedules?: string[];
6282
6152
  location?: LocationConfig;
6153
+ additionalData?: Record<string, unknown>;
6283
6154
  }
6284
6155
  interface ExtractOptions extends Omit<ExtractOptionsInternal, "navigationMode" | "entity"> {
6285
6156
  navigationMode?: NavigationMode;
@@ -6307,9 +6178,15 @@ interface RunWorkflowOptions {
6307
6178
  interface CreatedExtraction {
6308
6179
  options: ExtractOptionsInternal;
6309
6180
  workflowId: string;
6181
+ waitForReady: (options?: WaitForReadyOptions) => Promise<GetWorkflowResponse>;
6310
6182
  run: (options?: RunWorkflowOptions) => Promise<FinishedExtraction>;
6311
6183
  submit: (options?: RunWorkflowOptions) => Promise<SubmittedExtraction>;
6312
6184
  }
6185
+ interface WaitForReadyOptions {
6186
+ targetState?: "PREVIEW" | "ACTIVE";
6187
+ pollIntervalMs?: number;
6188
+ timeoutMs?: number;
6189
+ }
6313
6190
  interface SubmittedExtraction {
6314
6191
  workflowId: string;
6315
6192
  jobId: string;
@@ -6335,7 +6212,7 @@ declare class ExtractionBuilderService {
6335
6212
  get workflowId(): string;
6336
6213
  get jobId(): string;
6337
6214
  constructor(workflowsCoreService: WorkflowsCoreService, entityResolverService: EntityResolverService, dataFetcherService: DataFetcherService, notificationSetupService: NotificationSetupService);
6338
- extract({ urls, name, description, navigationMode, extraction, }: ExtractOptions): PreparedExtraction;
6215
+ extract({ urls, name, description, navigationMode, extraction, additionalData, bypassPreview, }: ExtractOptions): PreparedExtraction;
6339
6216
  withNotifications(options: Omit<NotificationOptions, "workflowId">): PreparedExtraction;
6340
6217
  withMonitoring(options: WorkflowMonitoringConfig): PreparedExtraction;
6341
6218
  bypassPreview(): PreparedExtraction;
@@ -6346,6 +6223,7 @@ declare class ExtractionBuilderService {
6346
6223
  }): PreparedExtraction;
6347
6224
  setLocation(options: LocationConfig): PreparedExtraction;
6348
6225
  create(): Promise<CreatedExtraction>;
6226
+ waitForReady(options?: WaitForReadyOptions): Promise<GetWorkflowResponse>;
6349
6227
  run(options?: RunWorkflowOptions): Promise<FinishedExtraction>;
6350
6228
  submit(options?: RunWorkflowOptions): Promise<SubmittedExtraction>;
6351
6229
  fetchData(options: Omit<FetchDataOptions, "workflowId" | "runId">): Promise<FetchDataResult>;
@@ -6753,6 +6631,7 @@ interface EntityRequestOptions {
6753
6631
  link: string;
6754
6632
  location?: LocationConfig;
6755
6633
  navigationMode?: string;
6634
+ selectorMode?: boolean;
6756
6635
  }
6757
6636
  interface ResolvedEntity {
6758
6637
  entity?: string;
@@ -6786,6 +6665,7 @@ declare class EntityResolverService {
6786
6665
  link?: string;
6787
6666
  location?: LocationConfig;
6788
6667
  navigationMode?: string;
6668
+ selectorMode?: boolean;
6789
6669
  }): Promise<ResolvedEntity>;
6790
6670
  /**
6791
6671
  * Fetches entity fields dynamically from the /v4/entity endpoint.
@@ -6928,4 +6808,4 @@ declare class KadoaHttpException extends KadoaSdkException {
6928
6808
  static mapStatusToCode(errorOrStatus: AxiosError | number): KadoaErrorCode;
6929
6809
  }
6930
6810
 
6931
- export { type BulkApproveRulesRequest, type BulkApproveRulesResponseData, type BulkDeleteRulesRequest, type BulkDeleteRulesResponseData, type Category, type ChannelConfig, type ChannelSetupRequestConfig, type CreateChannelRequest, type CreateRuleRequest, type CreateSchemaRequest, type CreateSettingsRequest, type CreateWorkflowInput, type CreateWorkflowRequest, type CreateWorkflowWithCustomSchemaRequest, type CreatedExtraction, DataFetcherService, type DataPagination, DataSortOrder, type DataType, type DeleteAllRulesRequest, type DeleteAllRulesResponseData, type DisableRuleRequest, ERROR_MESSAGES, type EmailChannelConfig, EntityResolverService, type ExtractOptions, ExtractionBuilderService, type ExtractionOptions, type ExtractionResult, ExtractionService, FetchDataOptions, type FetchDataResult, type FieldExample, type FieldOptions, type FieldType, type FinishedExtraction, type GenerateRuleRequest, type GenerateRulesRequest, type GetAnomaliesByRuleResponse, type GetAnomalyRulePageResponse, type GetJobResponse, type GetValidationResponse, type GetWorkflowResponse, type JobId, JobStateEnum, type JobWaitOptions, KadoaClient, type KadoaClientConfig, KadoaErrorCode, KadoaHttpException, KadoaSdkException, type KadoaUser, ListChannelsRequest, ListRulesRequest, type ListRulesResponse, ListSettingsRequest, type ListValidationsResponse, ListWorkflowValidationsRequest, ListWorkflowsRequest, type LocationConfig, type MetadataKey, type MonitoringConfig, type MonitoringField, type MonitoringOperator, MonitoringStatus, type NavigationMode, type NotificationChannel, type NotificationChannelConfig, NotificationChannelType, NotificationChannelsService, type NotificationDomain, type NotificationOptions, type NotificationSettings, type NotificationSettingsEventType, V5NotificationsSettingsGetEventTypeEnum as NotificationSettingsEventTypeEnum, NotificationSettingsService, type NotificationSetupRequestChannels, NotificationSetupService, type PollingOptions, type PreparedExtraction, type RawFormat, Realtime, 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 SetupWorkflowNotificationSettingsRequest, type SetupWorkspaceNotificationSettingsRequest, type SlackChannelConfig, type SubmitExtractionResult, type SubmittedExtraction, type ToggleValidationResponse, UpdateInterval, type UpdateRuleRequest, type UpdateSchemaRequest, UserService, ValidationCoreService, type ValidationDomain, ValidationRulesService, ValidationStrategy, 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, pollUntil };
6811
+ export { type BulkApproveRulesRequest, type BulkApproveRulesResponseData, type BulkDeleteRulesRequest, type BulkDeleteRulesResponseData, type Category, type ChannelConfig, type ChannelSetupRequestConfig, type CreateChannelRequest, type CreateRuleRequest, type CreateSchemaRequest, type CreateSettingsRequest, type CreateWorkflowInput, type CreateWorkflowRequest, type CreateWorkflowWithCustomSchemaRequest, type CreatedExtraction, DataFetcherService, type DataPagination, DataSortOrder, type DataType, type DeleteAllRulesRequest, type DeleteAllRulesResponseData, type DisableRuleRequest, ERROR_MESSAGES, type EmailChannelConfig, EntityResolverService, type ExtractOptions, ExtractionBuilderService, type ExtractionOptions, type ExtractionResult, ExtractionService, FetchDataOptions, type FetchDataResult, type FieldExample, type FieldOptions, type FieldType, type FinishedExtraction, type GenerateRuleRequest, type GenerateRulesRequest, type GetAnomaliesByRuleResponse, type GetAnomalyRulePageResponse, type GetJobResponse, type GetValidationResponse, type GetWorkflowResponse, type JobId, JobStateEnum, type JobWaitOptions, KadoaClient, type KadoaClientConfig, KadoaErrorCode, KadoaHttpException, KadoaSdkException, type KadoaUser, ListChannelsRequest, ListRulesRequest, type ListRulesResponse, ListSettingsRequest, type ListValidationsResponse, ListWorkflowValidationsRequest, ListWorkflowsRequest, type LocationConfig, type MetadataKey, type MonitoringConfig, type MonitoringField, type MonitoringOperator, MonitoringStatus, type NavigationMode, type NotificationChannel, type NotificationChannelConfig, NotificationChannelType, NotificationChannelsService, type NotificationDomain, type NotificationOptions, type NotificationSettings, type NotificationSettingsEventType, V5NotificationsSettingsGetEventTypeEnum as NotificationSettingsEventTypeEnum, NotificationSettingsService, type NotificationSetupRequestChannels, NotificationSetupService, type PollingOptions, type PreparedExtraction, type RawFormat, Realtime, 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 SetupWorkflowNotificationSettingsRequest, type SetupWorkspaceNotificationSettingsRequest, type SlackChannelConfig, type SubmitExtractionResult, type SubmittedExtraction, 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, pollUntil, validateAdditionalData };