Skip to main content

@wildix/wim-knowledge-base-client > DataSourceItem

DataSourceItem interface

Signature:

export interface DataSourceItem 

Properties

Property

Modifiers

Type

Description

companyId

string

Company ID that owns this data source

config

DataSourceConfig

Configuration specific to the data source type. Union containing ConfluenceConfig, GDriveConfig, or empty Document for file-based sources. Configuration structure varies based on the data source type

createdAt

string

Timestamp when the data source was created (ISO 8601 format). Example: 2025-01-01T00:00:00Z

description?

string | undefined

(Optional) Optional detailed description of the data source content and purpose. Helps users understand what data is included. Examples: 'Contains product documentation and service guides from Confluence', 'Customer service articles synced from Zendesk'. Length: 0-1000 characters

id

string

Unique identifier of the data source

name

string

Descriptive name for the data source. Used for identification and display in the UI. Examples: 'Product Confluence', 'Customer Service Docs', 'Engineering Wikis'. Length: 2-100 characters

syncSchedule?

ScheduleConfiguration | undefined

(Optional) Automatic synchronization schedule for keeping the data source up-to-date. Options: 'DISABLED' (manual sync only), 'EVERY_SIX_HOURS', 'EVERY_TWELVE_HOURS', 'EVERY_DAY', 'EVERY_WEEK'. Defaults to 'EVERY_DAY' if not specified

type

DataSourceType

The source system type for this data source. Supported values: 'files' (uploaded documents), 'confluence' (Atlassian Confluence), 'gdrive' (Google Drive), 'proxy' (custom API endpoint)

updatedAt

string

Timestamp when the data source was last updated (ISO 8601 format). Example: 2025-01-01T00:00:00Z