@kadoa/node-sdk 0.16.2 → 0.18.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
@@ -11,11 +11,23 @@ import { RawAxiosRequestConfig, AxiosPromise, AxiosInstance, AxiosError } from '
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ interface AWSv4Configuration {
15
+ options?: {
16
+ region?: string;
17
+ service?: string;
18
+ };
19
+ credentials?: {
20
+ accessKeyId?: string;
21
+ secretAccessKey?: string;
22
+ sessionToken?: string;
23
+ };
24
+ }
14
25
  interface ConfigurationParameters {
15
26
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
16
27
  username?: string;
17
28
  password?: string;
18
29
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
30
+ awsv4?: AWSv4Configuration;
19
31
  basePath?: string;
20
32
  serverIndex?: number;
21
33
  baseOptions?: any;
@@ -41,6 +53,17 @@ declare class Configuration {
41
53
  * @param scopes oauth2 scope
42
54
  */
43
55
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
56
+ /**
57
+ * parameter for aws4 signature security
58
+ * @param {Object} AWS4Signature - AWS4 Signature security
59
+ * @param {string} options.region - aws region
60
+ * @param {string} options.service - name of the service.
61
+ * @param {string} credentials.accessKeyId - aws access key id
62
+ * @param {string} credentials.secretAccessKey - aws access key
63
+ * @param {string} credentials.sessionToken - aws session token
64
+ * @memberof Configuration
65
+ */
66
+ awsv4?: AWSv4Configuration;
44
67
  /**
45
68
  * override base path
46
69
  */
@@ -622,9 +645,9 @@ interface AgenticWorkflow {
622
645
  */
623
646
  'dataValidationEnabled'?: boolean;
624
647
  /**
625
- * Additional static data for the workflow (e.g. IDs from your system to link data)
648
+ * Additional data for the workflow (e.g. IDs from your system to link data)
626
649
  */
627
- 'additionalData'?: object | null;
650
+ 'additionalData'?: any | null;
628
651
  /**
629
652
  * Natural language instructions for the AI agent (10-5000 characters). Describe what data to extract and how to navigate the site
630
653
  */
@@ -1142,13 +1165,13 @@ interface WorkflowWithEntityAndFields {
1142
1165
  */
1143
1166
  'dataValidationEnabled'?: boolean;
1144
1167
  /**
1145
- * Additional static data for the workflow
1168
+ * Additional data for the workflow (e.g. IDs from your system to link data)
1146
1169
  */
1147
- 'additionalData'?: object;
1170
+ 'additionalData'?: any | null;
1148
1171
  /**
1149
1172
  * Entity name for extraction (e.g., \'Product\', \'JobListing\')
1150
1173
  */
1151
- 'schemaId'?: string;
1174
+ 'entity': string;
1152
1175
  /**
1153
1176
  * Array of fields to extract from each item. Each field defines a property to capture (e.g., title, price, description)
1154
1177
  */
@@ -1250,13 +1273,9 @@ interface WorkflowWithExistingSchema {
1250
1273
  */
1251
1274
  'dataValidationEnabled'?: boolean;
1252
1275
  /**
1253
- * Additional static data for the workflow
1276
+ * Additional data for the workflow (e.g. IDs from your system to link data)
1254
1277
  */
1255
- 'additionalData'?: object;
1256
- /**
1257
- * Entity name for extraction
1258
- */
1259
- 'entity'?: string;
1278
+ 'additionalData'?: any | null;
1260
1279
  /**
1261
1280
  * ID of an existing schema configuration. Use this to reference a previously defined schema without re-defining extraction fields
1262
1281
  */
@@ -2563,10 +2582,6 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2563
2582
  * Maximum number of items to scrape
2564
2583
  */
2565
2584
  'limit'?: number;
2566
- /**
2567
- * Additional static data for the workflow
2568
- */
2569
- 'additionalData'?: object;
2570
2585
  /**
2571
2586
  * When the last job finished
2572
2587
  */
@@ -2631,6 +2646,12 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2631
2646
  */
2632
2647
  'monitoring'?: boolean;
2633
2648
  'notificationConfig'?: V4WorkflowsWorkflowIdGet200ResponseNotificationConfig;
2649
+ /**
2650
+ * Number of connected channels per event type
2651
+ */
2652
+ 'channelCounts'?: {
2653
+ [key: string]: number;
2654
+ };
2634
2655
  }
2635
2656
  declare const V4WorkflowsGet200ResponseWorkflowsInnerStateEnum: {
2636
2657
  readonly Active: "ACTIVE";
@@ -2657,6 +2678,7 @@ declare const V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum: {
2657
2678
  readonly Setup: "SETUP";
2658
2679
  readonly Running: "RUNNING";
2659
2680
  readonly Failed: "FAILED";
2681
+ readonly Deleted: "DELETED";
2660
2682
  };
2661
2683
  type V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum = typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum[keyof typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum];
2662
2684
 
@@ -3160,6 +3182,12 @@ interface V4WorkflowsWorkflowIdGet200Response {
3160
3182
  'dataLinking'?: V4WorkflowsWorkflowIdGet200ResponseDataLinking;
3161
3183
  'validationStatistics'?: V4WorkflowsWorkflowIdGet200ResponseValidationStatistics;
3162
3184
  'notificationConfig'?: V4WorkflowsWorkflowIdGet200ResponseNotificationConfig;
3185
+ /**
3186
+ * Number of connected channels per event type
3187
+ */
3188
+ 'channelCounts'?: {
3189
+ [key: string]: number;
3190
+ };
3163
3191
  }
3164
3192
  declare const V4WorkflowsWorkflowIdGet200ResponseStateEnum: {
3165
3193
  readonly Active: "ACTIVE";
@@ -3185,6 +3213,7 @@ declare const V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum: {
3185
3213
  readonly Queued: "QUEUED";
3186
3214
  readonly Setup: "SETUP";
3187
3215
  readonly Running: "RUNNING";
3216
+ readonly Deleted: "DELETED";
3188
3217
  };
3189
3218
  type V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum = typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum];
3190
3219
 
@@ -3832,6 +3861,36 @@ type WebhookChannelConfigHttpMethodEnum = typeof WebhookChannelConfigHttpMethodE
3832
3861
  */
3833
3862
  type V5NotificationsChannelsGet200ResponseDataChannelsInnerConfig = EmailChannelConfig | SlackChannelConfig | WebhookChannelConfig | object;
3834
3863
 
3864
+ /**
3865
+ * Kadoa API
3866
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3867
+ *
3868
+ * The version of the OpenAPI document: 3.0.0
3869
+ * Contact: support@kadoa.com
3870
+ *
3871
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3872
+ * https://openapi-generator.tech
3873
+ * Do not edit the class manually.
3874
+ */
3875
+ interface V5NotificationsChannelsGet200ResponseDataChannelsInnerLinkedConfigurationsInner {
3876
+ /**
3877
+ * The configuration ID
3878
+ */
3879
+ 'configurationId'?: string;
3880
+ /**
3881
+ * Workflow ID if this is a workflow-specific configuration, null for workspace-level configurations
3882
+ */
3883
+ 'workflowId'?: string | null;
3884
+ /**
3885
+ * Event type for this configuration (e.g., workflow_sample_finished, workflow_data_change)
3886
+ */
3887
+ 'eventType'?: string;
3888
+ /**
3889
+ * Whether this configuration is enabled
3890
+ */
3891
+ 'enabled'?: boolean;
3892
+ }
3893
+
3835
3894
  /**
3836
3895
  * Kadoa API
3837
3896
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3849,10 +3908,48 @@ interface V5NotificationsChannelsGet200ResponseDataChannelsInner {
3849
3908
  'name'?: string;
3850
3909
  'channelType'?: string;
3851
3910
  'config'?: V5NotificationsChannelsGet200ResponseDataChannelsInnerConfig;
3911
+ /**
3912
+ * List of notification configurations linked to this channel
3913
+ */
3914
+ 'linkedConfigurations'?: Array<V5NotificationsChannelsGet200ResponseDataChannelsInnerLinkedConfigurationsInner>;
3852
3915
  'createdAt'?: string;
3853
3916
  'updatedAt'?: string;
3854
3917
  }
3855
3918
 
3919
+ /**
3920
+ * Kadoa API
3921
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3922
+ *
3923
+ * The version of the OpenAPI document: 3.0.0
3924
+ * Contact: support@kadoa.com
3925
+ *
3926
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3927
+ * https://openapi-generator.tech
3928
+ * Do not edit the class manually.
3929
+ */
3930
+
3931
+ interface V5NotificationsChannelsChannelIdGet200ResponseData {
3932
+ 'channel'?: V5NotificationsChannelsGet200ResponseDataChannelsInner;
3933
+ }
3934
+
3935
+ /**
3936
+ * Kadoa API
3937
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3938
+ *
3939
+ * The version of the OpenAPI document: 3.0.0
3940
+ * Contact: support@kadoa.com
3941
+ *
3942
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3943
+ * https://openapi-generator.tech
3944
+ * Do not edit the class manually.
3945
+ */
3946
+
3947
+ interface V5NotificationsChannelsChannelIdGet200Response {
3948
+ 'data'?: V5NotificationsChannelsChannelIdGet200ResponseData;
3949
+ 'status'?: string;
3950
+ 'message'?: string;
3951
+ }
3952
+
3856
3953
  /**
3857
3954
  * Kadoa API
3858
3955
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4506,7 +4603,7 @@ interface NotificationsApiInterface {
4506
4603
  * @param {*} [options] Override http request option.
4507
4604
  * @throws {RequiredError}
4508
4605
  */
4509
- v5NotificationsChannelsChannelIdGet(requestParameters: NotificationsApiV5NotificationsChannelsChannelIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V5NotificationsChannelsPost201Response>;
4606
+ v5NotificationsChannelsChannelIdGet(requestParameters: NotificationsApiV5NotificationsChannelsChannelIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V5NotificationsChannelsChannelIdGet200Response>;
4510
4607
  /**
4511
4608
  *
4512
4609
  * @summary Update a notification channel
@@ -4620,6 +4717,10 @@ interface NotificationsApiV5NotificationsChannelsChannelIdGetRequest {
4620
4717
  * Channel ID
4621
4718
  */
4622
4719
  readonly channelId: string;
4720
+ /**
4721
+ * Include linked notification configurations with workflow information
4722
+ */
4723
+ readonly includeConfigurations?: boolean;
4623
4724
  }
4624
4725
  /**
4625
4726
  * Request parameters for v5NotificationsChannelsChannelIdPut operation in NotificationsApi.
@@ -4639,6 +4740,10 @@ interface NotificationsApiV5NotificationsChannelsGetRequest {
4639
4740
  * Workflow ID (optional, if provided returns channels linked to this workflow)
4640
4741
  */
4641
4742
  readonly workflowId?: string;
4743
+ /**
4744
+ * Include linked notification configurations with workflow information
4745
+ */
4746
+ readonly includeConfigurations?: boolean;
4642
4747
  }
4643
4748
  /**
4644
4749
  * Request parameters for v5NotificationsChannelsPost operation in NotificationsApi.
@@ -5427,6 +5532,7 @@ declare const WorkflowDisplayStateEnum: {
5427
5532
  readonly Setup: "SETUP";
5428
5533
  readonly Running: "RUNNING";
5429
5534
  readonly Failed: "FAILED";
5535
+ readonly Deleted: "DELETED";
5430
5536
  };
5431
5537
  type WorkflowDisplayStateEnum = (typeof WorkflowDisplayStateEnum)[keyof typeof WorkflowDisplayStateEnum];
5432
5538
  /**
@@ -5901,7 +6007,7 @@ interface JobWaitOptions extends PollingOptions {
5901
6007
  interface CreateWorkflowInput {
5902
6008
  urls: string[];
5903
6009
  navigationMode: NavigationMode;
5904
- name: string;
6010
+ name?: string;
5905
6011
  description?: string;
5906
6012
  schemaId?: string;
5907
6013
  entity?: string;
@@ -5915,6 +6021,8 @@ interface CreateWorkflowInput {
5915
6021
  schedules?: string[];
5916
6022
  additionalData?: Record<string, unknown>;
5917
6023
  }
6024
+ declare const TERMINAL_JOB_STATES: Set<JobStateEnum>;
6025
+ declare const TERMINAL_RUN_STATES: Set<string>;
5918
6026
  declare class WorkflowsCoreService {
5919
6027
  private readonly workflowsApi;
5920
6028
  constructor(workflowsApi: WorkflowsApiInterface);
@@ -5954,7 +6062,7 @@ interface ExtractionOptionsInternal {
5954
6062
  prompt?: string;
5955
6063
  mode: "run" | "submit";
5956
6064
  navigationMode: NavigationMode;
5957
- name: string;
6065
+ name?: string;
5958
6066
  description?: string;
5959
6067
  location: LocationConfig;
5960
6068
  bypassPreview?: boolean;
@@ -6808,4 +6916,4 @@ declare class KadoaHttpException extends KadoaSdkException {
6808
6916
  static mapStatusToCode(errorOrStatus: AxiosError | number): KadoaErrorCode;
6809
6917
  }
6810
6918
 
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 };
6919
+ 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, type RealtimeConfig, 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, TERMINAL_JOB_STATES, TERMINAL_RUN_STATES, 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 };
package/dist/index.d.ts CHANGED
@@ -11,11 +11,23 @@ import { RawAxiosRequestConfig, AxiosPromise, AxiosInstance, AxiosError } from '
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ interface AWSv4Configuration {
15
+ options?: {
16
+ region?: string;
17
+ service?: string;
18
+ };
19
+ credentials?: {
20
+ accessKeyId?: string;
21
+ secretAccessKey?: string;
22
+ sessionToken?: string;
23
+ };
24
+ }
14
25
  interface ConfigurationParameters {
15
26
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
16
27
  username?: string;
17
28
  password?: string;
18
29
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
30
+ awsv4?: AWSv4Configuration;
19
31
  basePath?: string;
20
32
  serverIndex?: number;
21
33
  baseOptions?: any;
@@ -41,6 +53,17 @@ declare class Configuration {
41
53
  * @param scopes oauth2 scope
42
54
  */
43
55
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
56
+ /**
57
+ * parameter for aws4 signature security
58
+ * @param {Object} AWS4Signature - AWS4 Signature security
59
+ * @param {string} options.region - aws region
60
+ * @param {string} options.service - name of the service.
61
+ * @param {string} credentials.accessKeyId - aws access key id
62
+ * @param {string} credentials.secretAccessKey - aws access key
63
+ * @param {string} credentials.sessionToken - aws session token
64
+ * @memberof Configuration
65
+ */
66
+ awsv4?: AWSv4Configuration;
44
67
  /**
45
68
  * override base path
46
69
  */
@@ -622,9 +645,9 @@ interface AgenticWorkflow {
622
645
  */
623
646
  'dataValidationEnabled'?: boolean;
624
647
  /**
625
- * Additional static data for the workflow (e.g. IDs from your system to link data)
648
+ * Additional data for the workflow (e.g. IDs from your system to link data)
626
649
  */
627
- 'additionalData'?: object | null;
650
+ 'additionalData'?: any | null;
628
651
  /**
629
652
  * Natural language instructions for the AI agent (10-5000 characters). Describe what data to extract and how to navigate the site
630
653
  */
@@ -1142,13 +1165,13 @@ interface WorkflowWithEntityAndFields {
1142
1165
  */
1143
1166
  'dataValidationEnabled'?: boolean;
1144
1167
  /**
1145
- * Additional static data for the workflow
1168
+ * Additional data for the workflow (e.g. IDs from your system to link data)
1146
1169
  */
1147
- 'additionalData'?: object;
1170
+ 'additionalData'?: any | null;
1148
1171
  /**
1149
1172
  * Entity name for extraction (e.g., \'Product\', \'JobListing\')
1150
1173
  */
1151
- 'schemaId'?: string;
1174
+ 'entity': string;
1152
1175
  /**
1153
1176
  * Array of fields to extract from each item. Each field defines a property to capture (e.g., title, price, description)
1154
1177
  */
@@ -1250,13 +1273,9 @@ interface WorkflowWithExistingSchema {
1250
1273
  */
1251
1274
  'dataValidationEnabled'?: boolean;
1252
1275
  /**
1253
- * Additional static data for the workflow
1276
+ * Additional data for the workflow (e.g. IDs from your system to link data)
1254
1277
  */
1255
- 'additionalData'?: object;
1256
- /**
1257
- * Entity name for extraction
1258
- */
1259
- 'entity'?: string;
1278
+ 'additionalData'?: any | null;
1260
1279
  /**
1261
1280
  * ID of an existing schema configuration. Use this to reference a previously defined schema without re-defining extraction fields
1262
1281
  */
@@ -2563,10 +2582,6 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2563
2582
  * Maximum number of items to scrape
2564
2583
  */
2565
2584
  'limit'?: number;
2566
- /**
2567
- * Additional static data for the workflow
2568
- */
2569
- 'additionalData'?: object;
2570
2585
  /**
2571
2586
  * When the last job finished
2572
2587
  */
@@ -2631,6 +2646,12 @@ interface V4WorkflowsGet200ResponseWorkflowsInner {
2631
2646
  */
2632
2647
  'monitoring'?: boolean;
2633
2648
  'notificationConfig'?: V4WorkflowsWorkflowIdGet200ResponseNotificationConfig;
2649
+ /**
2650
+ * Number of connected channels per event type
2651
+ */
2652
+ 'channelCounts'?: {
2653
+ [key: string]: number;
2654
+ };
2634
2655
  }
2635
2656
  declare const V4WorkflowsGet200ResponseWorkflowsInnerStateEnum: {
2636
2657
  readonly Active: "ACTIVE";
@@ -2657,6 +2678,7 @@ declare const V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum: {
2657
2678
  readonly Setup: "SETUP";
2658
2679
  readonly Running: "RUNNING";
2659
2680
  readonly Failed: "FAILED";
2681
+ readonly Deleted: "DELETED";
2660
2682
  };
2661
2683
  type V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum = typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum[keyof typeof V4WorkflowsGet200ResponseWorkflowsInnerDisplayStateEnum];
2662
2684
 
@@ -3160,6 +3182,12 @@ interface V4WorkflowsWorkflowIdGet200Response {
3160
3182
  'dataLinking'?: V4WorkflowsWorkflowIdGet200ResponseDataLinking;
3161
3183
  'validationStatistics'?: V4WorkflowsWorkflowIdGet200ResponseValidationStatistics;
3162
3184
  'notificationConfig'?: V4WorkflowsWorkflowIdGet200ResponseNotificationConfig;
3185
+ /**
3186
+ * Number of connected channels per event type
3187
+ */
3188
+ 'channelCounts'?: {
3189
+ [key: string]: number;
3190
+ };
3163
3191
  }
3164
3192
  declare const V4WorkflowsWorkflowIdGet200ResponseStateEnum: {
3165
3193
  readonly Active: "ACTIVE";
@@ -3185,6 +3213,7 @@ declare const V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum: {
3185
3213
  readonly Queued: "QUEUED";
3186
3214
  readonly Setup: "SETUP";
3187
3215
  readonly Running: "RUNNING";
3216
+ readonly Deleted: "DELETED";
3188
3217
  };
3189
3218
  type V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum = typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum[keyof typeof V4WorkflowsWorkflowIdGet200ResponseDisplayStateEnum];
3190
3219
 
@@ -3832,6 +3861,36 @@ type WebhookChannelConfigHttpMethodEnum = typeof WebhookChannelConfigHttpMethodE
3832
3861
  */
3833
3862
  type V5NotificationsChannelsGet200ResponseDataChannelsInnerConfig = EmailChannelConfig | SlackChannelConfig | WebhookChannelConfig | object;
3834
3863
 
3864
+ /**
3865
+ * Kadoa API
3866
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3867
+ *
3868
+ * The version of the OpenAPI document: 3.0.0
3869
+ * Contact: support@kadoa.com
3870
+ *
3871
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3872
+ * https://openapi-generator.tech
3873
+ * Do not edit the class manually.
3874
+ */
3875
+ interface V5NotificationsChannelsGet200ResponseDataChannelsInnerLinkedConfigurationsInner {
3876
+ /**
3877
+ * The configuration ID
3878
+ */
3879
+ 'configurationId'?: string;
3880
+ /**
3881
+ * Workflow ID if this is a workflow-specific configuration, null for workspace-level configurations
3882
+ */
3883
+ 'workflowId'?: string | null;
3884
+ /**
3885
+ * Event type for this configuration (e.g., workflow_sample_finished, workflow_data_change)
3886
+ */
3887
+ 'eventType'?: string;
3888
+ /**
3889
+ * Whether this configuration is enabled
3890
+ */
3891
+ 'enabled'?: boolean;
3892
+ }
3893
+
3835
3894
  /**
3836
3895
  * Kadoa API
3837
3896
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3849,10 +3908,48 @@ interface V5NotificationsChannelsGet200ResponseDataChannelsInner {
3849
3908
  'name'?: string;
3850
3909
  'channelType'?: string;
3851
3910
  'config'?: V5NotificationsChannelsGet200ResponseDataChannelsInnerConfig;
3911
+ /**
3912
+ * List of notification configurations linked to this channel
3913
+ */
3914
+ 'linkedConfigurations'?: Array<V5NotificationsChannelsGet200ResponseDataChannelsInnerLinkedConfigurationsInner>;
3852
3915
  'createdAt'?: string;
3853
3916
  'updatedAt'?: string;
3854
3917
  }
3855
3918
 
3919
+ /**
3920
+ * Kadoa API
3921
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3922
+ *
3923
+ * The version of the OpenAPI document: 3.0.0
3924
+ * Contact: support@kadoa.com
3925
+ *
3926
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3927
+ * https://openapi-generator.tech
3928
+ * Do not edit the class manually.
3929
+ */
3930
+
3931
+ interface V5NotificationsChannelsChannelIdGet200ResponseData {
3932
+ 'channel'?: V5NotificationsChannelsGet200ResponseDataChannelsInner;
3933
+ }
3934
+
3935
+ /**
3936
+ * Kadoa API
3937
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3938
+ *
3939
+ * The version of the OpenAPI document: 3.0.0
3940
+ * Contact: support@kadoa.com
3941
+ *
3942
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3943
+ * https://openapi-generator.tech
3944
+ * Do not edit the class manually.
3945
+ */
3946
+
3947
+ interface V5NotificationsChannelsChannelIdGet200Response {
3948
+ 'data'?: V5NotificationsChannelsChannelIdGet200ResponseData;
3949
+ 'status'?: string;
3950
+ 'message'?: string;
3951
+ }
3952
+
3856
3953
  /**
3857
3954
  * Kadoa API
3858
3955
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4506,7 +4603,7 @@ interface NotificationsApiInterface {
4506
4603
  * @param {*} [options] Override http request option.
4507
4604
  * @throws {RequiredError}
4508
4605
  */
4509
- v5NotificationsChannelsChannelIdGet(requestParameters: NotificationsApiV5NotificationsChannelsChannelIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V5NotificationsChannelsPost201Response>;
4606
+ v5NotificationsChannelsChannelIdGet(requestParameters: NotificationsApiV5NotificationsChannelsChannelIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V5NotificationsChannelsChannelIdGet200Response>;
4510
4607
  /**
4511
4608
  *
4512
4609
  * @summary Update a notification channel
@@ -4620,6 +4717,10 @@ interface NotificationsApiV5NotificationsChannelsChannelIdGetRequest {
4620
4717
  * Channel ID
4621
4718
  */
4622
4719
  readonly channelId: string;
4720
+ /**
4721
+ * Include linked notification configurations with workflow information
4722
+ */
4723
+ readonly includeConfigurations?: boolean;
4623
4724
  }
4624
4725
  /**
4625
4726
  * Request parameters for v5NotificationsChannelsChannelIdPut operation in NotificationsApi.
@@ -4639,6 +4740,10 @@ interface NotificationsApiV5NotificationsChannelsGetRequest {
4639
4740
  * Workflow ID (optional, if provided returns channels linked to this workflow)
4640
4741
  */
4641
4742
  readonly workflowId?: string;
4743
+ /**
4744
+ * Include linked notification configurations with workflow information
4745
+ */
4746
+ readonly includeConfigurations?: boolean;
4642
4747
  }
4643
4748
  /**
4644
4749
  * Request parameters for v5NotificationsChannelsPost operation in NotificationsApi.
@@ -5427,6 +5532,7 @@ declare const WorkflowDisplayStateEnum: {
5427
5532
  readonly Setup: "SETUP";
5428
5533
  readonly Running: "RUNNING";
5429
5534
  readonly Failed: "FAILED";
5535
+ readonly Deleted: "DELETED";
5430
5536
  };
5431
5537
  type WorkflowDisplayStateEnum = (typeof WorkflowDisplayStateEnum)[keyof typeof WorkflowDisplayStateEnum];
5432
5538
  /**
@@ -5901,7 +6007,7 @@ interface JobWaitOptions extends PollingOptions {
5901
6007
  interface CreateWorkflowInput {
5902
6008
  urls: string[];
5903
6009
  navigationMode: NavigationMode;
5904
- name: string;
6010
+ name?: string;
5905
6011
  description?: string;
5906
6012
  schemaId?: string;
5907
6013
  entity?: string;
@@ -5915,6 +6021,8 @@ interface CreateWorkflowInput {
5915
6021
  schedules?: string[];
5916
6022
  additionalData?: Record<string, unknown>;
5917
6023
  }
6024
+ declare const TERMINAL_JOB_STATES: Set<JobStateEnum>;
6025
+ declare const TERMINAL_RUN_STATES: Set<string>;
5918
6026
  declare class WorkflowsCoreService {
5919
6027
  private readonly workflowsApi;
5920
6028
  constructor(workflowsApi: WorkflowsApiInterface);
@@ -5954,7 +6062,7 @@ interface ExtractionOptionsInternal {
5954
6062
  prompt?: string;
5955
6063
  mode: "run" | "submit";
5956
6064
  navigationMode: NavigationMode;
5957
- name: string;
6065
+ name?: string;
5958
6066
  description?: string;
5959
6067
  location: LocationConfig;
5960
6068
  bypassPreview?: boolean;
@@ -6808,4 +6916,4 @@ declare class KadoaHttpException extends KadoaSdkException {
6808
6916
  static mapStatusToCode(errorOrStatus: AxiosError | number): KadoaErrorCode;
6809
6917
  }
6810
6918
 
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 };
6919
+ 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, type RealtimeConfig, 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, TERMINAL_JOB_STATES, TERMINAL_RUN_STATES, 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 };