@kadoa/node-sdk 0.12.1 → 0.13.0

package/dist/index.d.ts

@@ -648,6 +648,36 @@ type ExtractionSchemaFieldDataTypeEnum = typeof ExtractionSchemaFieldDataTypeEnu
  */
 type SchemaResponseSchemaInner = ExtractionClassificationField | ExtractionMetadataField | ExtractionSchemaField;
 
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Request body for creating a new schema
+ */
+interface CreateSchemaBody {
+    /**
+     * Name of the schema
+     */
+    'name': string;
+    /**
+     * Entity type for the schema
+     */
+    'entity': string;
+    /**
+     * Array of field definitions
+     */
+    'fields': Array<SchemaResponseSchemaInner>;
+}
+
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1651,6 +1681,74 @@ interface ScheduleValidationResponse {
     'createdAt': string;
 }
 
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema description metadata
+ */
+interface SchemaResponseDescription {
+    /**
+     * Hint text for the schema
+     */
+    'hintText': string;
+}
+
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Schema object response
+ */
+interface SchemaResponse {
+    /**
+     * Unique identifier for the schema
+     */
+    'id': string;
+    /**
+     * Name of the schema
+     */
+    'name': string;
+    /**
+     * Schema type (always NEO)
+     */
+    'type': SchemaResponseTypeEnum;
+    /**
+     * Whether the schema is public
+     */
+    'isPublic': boolean;
+    /**
+     * Array of field definitions
+     */
+    'schema': Array<SchemaResponseSchemaInner>;
+    /**
+     * Entity type for the schema
+     */
+    'entity': string | null;
+    'description': SchemaResponseDescription;
+}
+declare const SchemaResponseTypeEnum: {
+    readonly Neo: "NEO";
+};
+type SchemaResponseTypeEnum = typeof SchemaResponseTypeEnum[keyof typeof SchemaResponseTypeEnum];
+
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1710,6 +1808,36 @@ declare const UpdateRuleStatusEnum: {
 };
 type UpdateRuleStatusEnum = typeof UpdateRuleStatusEnum[keyof typeof UpdateRuleStatusEnum];
 
+/**
+ * Kadoa API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@kadoa.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Request body for updating a schema
+ */
+interface UpdateSchemaBody {
+    /**
+     * Name of the schema
+     */
+    'name'?: string;
+    /**
+     * Entity type for the schema
+     */
+    'entity'?: string | null;
+    /**
+     * Array of field definitions
+     */
+    'fields'?: Array<SchemaResponseSchemaInner>;
+}
+
 /**
  * Kadoa API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5459,8 +5587,17 @@ declare class DataFetcherService {
 }
 
 type NavigationMode = (typeof CreateWorkflowWithSchemaBodyNavigationModeEnum)[keyof typeof CreateWorkflowWithSchemaBodyNavigationModeEnum];
+type DataTypeInternal = (typeof ExtractionSchemaFieldDataTypeEnum)[keyof typeof ExtractionSchemaFieldDataTypeEnum];
+type DataType = Exclude<DataTypeInternal, "CURRENCY" | "JOB_DESCRIPTION" | "CATEGORY_JOB_TYPES" | "CLASSIFICATION" | "CATEGORIZE" | "STATIC_SCRAPER_DATA" | "UNIQUE_ID" | "JOBBIRD_CUSTOM" | "PASS" | "ADDITIONAL_DATA">;
+type MetadataKey = (typeof ExtractionMetadataFieldMetadataKeyEnum)[keyof typeof ExtractionMetadataFieldMetadataKeyEnum];
 type WorkflowInterval = (typeof CreateWorkflowWithSchemaBodyIntervalEnum)[keyof typeof CreateWorkflowWithSchemaBodyIntervalEnum];
+type MonitoringOperator = (typeof V4WorkflowsWorkflowIdMetadataPutRequestMonitoringFieldsInnerOperatorEnum)[keyof typeof V4WorkflowsWorkflowIdMetadataPutRequestMonitoringFieldsInnerOperatorEnum];
+type MonitoringField = V4WorkflowsWorkflowIdMetadataPutRequestMonitoringFieldsInner & {
+    isKeyField?: boolean;
+};
 type LocationConfig$1 = Location;
+type RawFormat = (typeof ExtractionMetadataFieldMetadataKeyEnum)[keyof typeof ExtractionMetadataFieldMetadataKeyEnum];
+type FieldType = ExtractionMetadataFieldFieldTypeEnum | ExtractionClassificationFieldFieldTypeEnum | ExtractionSchemaFieldFieldTypeEnum;
 
 type SchemaField = ExtractionSchemaField | ExtractionClassificationField | ExtractionMetadataField;
 interface EntityPrediction {
@@ -5479,7 +5616,7 @@ interface ResolvedEntity {
     fields: SchemaField[];
 }
 type EntityConfig = "ai-detection" | {
-    schemId: string;
+    schemaId: string;
 } | {
     name: string;
     fields: SchemaField[];
@@ -5998,10 +6135,6 @@ declare class NotificationsModule {
     get settings(): NotificationSettingsService;
 }
 
-interface Schema {
-    entity: string;
-    schema: SchemaField[];
-}
 /**
  * Service for managing schemas
  */
@@ -6010,17 +6143,147 @@ declare class SchemasService {
     constructor(client: KadoaClient);
     /**
      * Get a schema by ID
-     * //todo: use proper schema type for response from generated client (when avaialble)
      */
-    getSchema(schemaId: string): Promise<Schema>;
+    getSchema(schemaId: string): Promise<SchemaResponse>;
+    /**
+     * List all schemas
+     */
+    listSchemas(): Promise<SchemaResponse[]>;
+    /**
+     * Create a new schema
+     */
+    createSchema(body: CreateSchemaBody): Promise<SchemaResponse>;
+    /**
+     * Update an existing schema
+     */
+    updateSchema(schemaId: string, body: UpdateSchemaBody): Promise<SchemaResponse>;
+    /**
+     * Delete a schema
+     */
+    deleteSchema(schemaId: string): Promise<void>;
 }
 
+/**
+ * Example value for a field (re-exported from generated types)
+ */
+type FieldExample = ExtractionSchemaFieldExample;
+/**
+ * Optional configuration for schema fields
+ */
+interface FieldOptions {
+    /**
+     * Example value for the field (required for STRING, IMAGE, LINK, OBJECT, ARRAY)
+     * Can be a string or an array of strings
+     */
+    example?: FieldExample;
+    /**
+     * Whether this field is a primary key
+     */
+    isKey?: boolean;
+}
+/**
+ * Category definition for classification fields (re-exported from generated types)
+ */
+type Category = ExtractionClassificationFieldCategoriesInner;
+/**
+ * Builder for defining custom schemas with fields
+ */
+declare class SchemaBuilder {
+    private static readonly FIELD_NAME_PATTERN;
+    private static readonly TYPES_REQUIRING_EXAMPLE;
+    readonly fields: SchemaField[];
+    entityName?: string;
+    entity(entityName: string): this;
+    /**
+     * Add a structured field to the schema
+     * @param name - Field name (alphanumeric only)
+     * @param description - Field description
+     * @param dataType - Data type (STRING, NUMBER, BOOLEAN, etc.)
+     * @param options - Optional field configuration
+     */
+    field(name: string, description: string, dataType: DataType, options?: FieldOptions): this;
+    /**
+     * Add a classification field to categorize content
+     * @param name - Field name (alphanumeric only)
+     * @param description - Field description
+     * @param categories - Array of category definitions
+     */
+    classify(name: string, description: string, categories: Category[]): this;
+    /**
+     * Add raw page content to extract
+     * @param name - Raw content format(s): "html", "markdown", or "url"
+     */
+    raw(name: RawFormat | RawFormat[]): this;
+    build(): {
+        entityName: string;
+        fields: SchemaField[];
+    };
+    private validateFieldName;
+}
+
+/**
+ * Schema builder with create capability
+ * Extends SchemaBuilder to add direct schema creation
+ */
+declare class SchemaBuilderWithCreate extends SchemaBuilder {
+    private readonly service;
+    constructor(entityName: string, service: SchemasService);
+    /**
+     * Create the schema directly in Kadoa
+     * @param name - Optional schema name (defaults to entity name)
+     * @returns Promise resolving to the created schema
+     */
+    create(name?: string): Promise<SchemaResponse>;
+}
 /**
  * Schemas module for managing schemas
  */
 declare class SchemasModule {
     private readonly service;
     constructor(service: SchemasService);
+    /**
+     * Create a new schema builder for fluent schema definition
+     * @param entityName - The name of the entity this schema represents
+     * @returns A new SchemaBuilder instance with the entity name already set
+     * @example Build then create
+     * ```typescript
+     * const schema = kadoa.schema.builder("Product")
+     *   .field("title", "Product name", "STRING", { example: "iPhone 15" })
+     *   .field("price", "Product price", "NUMBER")
+     *   .build();
+     *
+     * await kadoa.schema.create(schema);
+     * ```
+     *
+     * @example Fluent chain with create
+     * ```typescript
+     * const schema = await kadoa.schema.builder("Product")
+     *   .field("title", "Product name", "STRING", { example: "iPhone 15" })
+     *   .field("price", "Product price", "NUMBER")
+     *   .create("Product Schema");
+     * ```
+     */
+    builder(entityName: string): SchemaBuilderWithCreate;
+    /**
+     * Get a schema by ID
+     */
+    get(schemaId: string): Promise<SchemaResponse>;
+    /**
+     * List all schemas
+     */
+    list(): Promise<SchemaResponse[]>;
+    /**
+     * Create a new schema from a body
+     */
+    create(body: CreateSchemaBody): Promise<SchemaResponse>;
+    /**
+     * Update an existing schema
+     */
+    update(schemaId: string, body: UpdateSchemaBody): Promise<SchemaResponse>;
+    /**
+     * Delete a schema
+     */
+    delete(schemaId: string): Promise<void>;
 }
 
 /**
@@ -6151,97 +6414,6 @@ declare class WorkflowsModule {
     waitForJobCompletion(workflowId: string, jobId: string, options?: JobWaitOptions): Promise<FinishedJob>;
 }
 
-/**
- * Raw content format options
- */
-type RawFormat = "html" | "markdown" | "url";
-/**
- * Data type for schema fields
- */
-type DataType = (typeof ExtractionSchemaFieldDataTypeEnum)[keyof typeof ExtractionSchemaFieldDataTypeEnum];
-/**
- * Optional configuration for schema fields
- */
-interface FieldOptions {
-    /**
-     * Example value for the field (required for STRING, IMAGE, LINK, OBJECT, ARRAY)
-     * Can be a string or an array of strings
-     */
-    example?: ExtractionSchemaFieldExample;
-    /**
-     * Whether this field is a primary key
-     */
-    isKey?: boolean;
-}
-/**
- * Category definition for classification fields
- */
-type Category = ExtractionClassificationFieldCategoriesInner;
-
-/**
- * Base builder for extraction configuration
- */
-declare class ExtractionBuilder {
-    protected fields: SchemaField[];
-    protected schemaName?: string;
-    protected schemaId?: string;
-    /**
-     * Start defining a custom schema with fields
-     * @param name - The entity name (e.g., "Product", "Article")
-     */
-    schema(name: string): SchemaBuilder;
-    /**
-     * Use an existing schema by ID
-     * @param schemaId - The schema ID to reference
-     */
-    useSchema(schemaId: string): this;
-    /**
-     * Extract raw page content without transformation
-     * @param format - Raw content format(s): "html", "markdown", or "url"
-     */
-    raw(format: RawFormat | RawFormat[]): this;
-    /**
-     * Get the fields array (internal use)
-     */
-    getFields(): SchemaField[];
-    /**
-     * Get the schema name (internal use)
-     */
-    getSchemaName(): string | undefined;
-    /**
-     * Get the schema ID (internal use)
-     */
-    getSchemaId(): string | undefined;
-}
-/**
- * Builder for defining custom schemas with fields
- */
-declare class SchemaBuilder extends ExtractionBuilder {
-    private static readonly FIELD_NAME_PATTERN;
-    private static readonly TYPES_REQUIRING_EXAMPLE;
-    constructor(parentBuilder: ExtractionBuilder);
-    /**
-     * Add a structured field to the schema
-     * @param name - Field name (alphanumeric only)
-     * @param description - Field description
-     * @param dataType - Data type (STRING, NUMBER, BOOLEAN, etc.)
-     * @param options - Optional field configuration
-     */
-    field(name: string, description: string, dataType: DataType, options?: FieldOptions): this;
-    /**
-     * Add a classification field to categorize content
-     * @param name - Field name (alphanumeric only)
-     * @param description - Field description
-     * @param categories - Array of category definitions
-     */
-    classify(name: string, description: string, categories: Category[]): this;
-    /**
-     * Add raw page content alongside structured fields
-     * @param format - Raw content format(s): "html", "markdown", or "url"
-     */
-    raw(format: RawFormat | RawFormat[]): this;
-}
-
 interface ExtractOptionsInternal {
     urls: string[];
     name: string;
@@ -6265,7 +6437,9 @@ interface ExtractOptions extends Omit<ExtractOptionsInternal, "navigationMode" |
      *   .field("price", "Product price", "CURRENCY")
      * ```
      */
-    extraction?: (builder: ExtractionBuilder) => ExtractionBuilder;
+    extraction?: (builder: SchemaBuilder) => SchemaBuilder | {
+        schemaId: string;
+    };
 }
 interface PreparedExtraction {
     options: ExtractOptionsInternal;
@@ -6520,6 +6694,9 @@ declare class KadoaSdkException extends Error {
         readonly SCHEMA_NOT_FOUND: "Schema not found";
         readonly SCHEMA_FETCH_ERROR: "Failed to fetch schema";
         readonly SCHEMAS_FETCH_ERROR: "Failed to fetch schemas";
+        readonly SCHEMA_CREATE_FAILED: "Failed to create schema";
+        readonly SCHEMA_UPDATE_FAILED: "Failed to update schema";
+        readonly SCHEMA_DELETE_FAILED: "Failed to delete schema";
     };
     constructor(message: string, options?: KadoaSdkExceptionOptions);
     static from(error: unknown, details?: Record<string, unknown>): KadoaSdkException;
@@ -6558,6 +6735,9 @@ declare const ERROR_MESSAGES: {
     readonly SCHEMA_NOT_FOUND: "Schema not found";
     readonly SCHEMA_FETCH_ERROR: "Failed to fetch schema";
     readonly SCHEMAS_FETCH_ERROR: "Failed to fetch schemas";
+    readonly SCHEMA_CREATE_FAILED: "Failed to create schema";
+    readonly SCHEMA_UPDATE_FAILED: "Failed to update schema";
+    readonly SCHEMA_DELETE_FAILED: "Failed to delete schema";
 };
 
 type KadoaHttpExceptionOptions = {
@@ -6590,4 +6770,4 @@ declare class KadoaHttpException extends KadoaSdkException {
     static mapStatusToCode(errorOrStatus: AxiosError | number): KadoaErrorCode;
 }
 
-export { ERROR_MESSAGES, type FinishedJob, KadoaClient, type KadoaClientConfig, KadoaErrorCode, KadoaHttpException, KadoaSdkException, type KadoaUser, type ListRulesOptions, type LocationConfig, type PollingOptions, type RunWorkflowInput, type Schema, type SchemaField, SchemasModule, type StartedJob, ValidationModule, pollUntil };
+export { type Category, type CreateSchemaBody, type DataType, ERROR_MESSAGES, type FieldExample, type FieldOptions, type FieldType, type FinishedJob, KadoaClient, type KadoaClientConfig, KadoaErrorCode, KadoaHttpException, KadoaSdkException, type KadoaUser, type ListRulesOptions, type LocationConfig, type MetadataKey, type MonitoringField, type MonitoringOperator, type NavigationMode, type PollingOptions, type RawFormat, type RunWorkflowInput, SchemaBuilder, type SchemaField, type SchemaResponse, SchemasModule, type StartedJob, type UpdateSchemaBody, ValidationModule, type WorkflowInterval, pollUntil };