zudello-chat-sdk 0.1.1

package/dist/types/types.d.ts

@@ -0,0 +1,2056 @@
+/**
+ * Zudello SDK Types
+ *
+ * TypeScript interfaces for all SDK operations.
+ */
+import type { ZudelloModel, ZudelloModule, ZudelloSubmodule } from './constants';
+/**
+ * Configuration options for ZudelloClient.
+ *
+ * If not provided, values are read from environment variables:
+ * - ZUDELLO_TOKEN
+ * - ZUDELLO_ORG_ID
+ * - ZUDELLO_TEAM_ID
+ * - ZUDELLO_CLUSTER_URL
+ * - ZUDELLO_AUTH_API_BASE
+ * - ZUDELLO_USER_ID (optional)
+ * - ZUDELLO_USER_EMAIL (optional)
+ */
+export interface ZudelloClientConfig {
+    /** Opaque authentication token */
+    token?: string;
+    /** Organization UUID */
+    organizationId?: string;
+    /** Team UUID */
+    teamId?: string;
+    /** Team's cluster URL (e.g., 'api.1.global.zudello.io') */
+    clusterUrl?: string;
+    /** Authentication API base URL */
+    authApiBase?: string;
+    /** User UUID (optional, for user-specific operations) */
+    userId?: string;
+    /** User email (optional) */
+    userEmail?: string;
+    /** Maximum number of retry attempts for failed requests (default: 3) */
+    maxRetries?: number;
+    /** Base delay in ms for exponential backoff (default: 1000) */
+    retryDelay?: number;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Filter operators supported by Zudello search.
+ *
+ * Append these suffixes to field names in filter objects:
+ * - `__in`: Value is in list (e.g., `status__in: ['REVIEW', 'APPROVAL']`)
+ * - `__gt`, `__gte`: Greater than (or equal)
+ * - `__lt`, `__lte`: Less than (or equal)
+ * - `__range`: Value is in range (e.g., `total__range: [1000, 5000]`)
+ * - `__icontains`: Case-insensitive contains
+ * - `__startswith`: Starts with string
+ * - `__isnull`: Is null/not null
+ * - `__or`: OR condition
+ */
+export type FilterOperator = '__in' | '__gt' | '__gte' | '__lt' | '__lte' | '__range' | '__icontains' | '__contains' | '__startswith' | '__endswith' | '__isnull' | '__or';
+/**
+ * Search options for querying Zudello resources.
+ *
+ * @example
+ * // Search for invoices over $1000 awaiting approval
+ * const options: SearchOptions = {
+ *     model: 'Transaction',
+ *     module: 'PURCHASING',
+ *     submodule: 'INVOICE',
+ *     filter: {
+ *         status__in: ['REVIEW', 'APPROVAL'],
+ *         total__gt: 1000
+ *     },
+ *     select: ['uuid', 'document_number', 'total', 'supplier'],
+ *     order_by: ['-total']
+ * };
+ */
+export interface SearchOptions {
+    /**
+     * The Zudello model to search.
+     * @example 'Transaction', 'Supplier', 'Item'
+     */
+    model: ZudelloModel | string;
+    /**
+     * Module filter (functional area).
+     * @example 'PURCHASING', 'SALES', 'EXPENSES'
+     */
+    module?: ZudelloModule | string;
+    /**
+     * Submodule filter (specific document type).
+     * @example 'INVOICE', 'ORDER', 'CLAIM'
+     */
+    submodule?: ZudelloSubmodule | string;
+    /**
+     * Filter criteria. Use operators like `__in`, `__gt`, `__lt`, `__range`.
+     * @example { status: 'REVIEW', total__gt: 1000, supplier__trading_name__icontains: 'acme' }
+     */
+    filter?: Record<string, unknown>;
+    /**
+     * Exclusion criteria (inverse of filter).
+     * @example { status: 'DELETED' }
+     */
+    exclude?: Record<string, unknown>;
+    /**
+     * Fields to include in response. Use dot notation for related fields.
+     * @example ['uuid', 'document_number', 'supplier__trading_name', 'total']
+     */
+    select?: string[];
+    /**
+     * Sort order. Prefix with `-` for descending.
+     * @example ['-created_at', 'document_number']
+     */
+    order_by?: string[];
+    /**
+     * Full-text search configuration.
+     */
+    search?: {
+        /** Fields to search in */
+        fields?: Array<{
+            name: string;
+        } | string>;
+        /** Search keywords */
+        keywords?: string[];
+        /** Search mode */
+        mode?: string;
+        /** Minimum search rank */
+        min_rank?: number;
+    };
+    /**
+     * Distinct field(s) for deduplication.
+     */
+    distinct?: string[];
+    /**
+     * Annotation expressions for computed fields.
+     */
+    annotate?: Record<string, unknown>;
+    /**
+     * Aggregation expressions (sum, count, avg, etc.).
+     */
+    aggregate?: Record<string, unknown>;
+    /**
+     * Number of results to skip (for pagination).
+     * @default 0
+     */
+    offset?: number;
+    /**
+     * Maximum number of results to return.
+     * @default 100
+     */
+    limit?: number;
+    /**
+     * Only return active (non-deleted) records.
+     * @default true
+     */
+    activeOnly?: boolean;
+}
+/**
+ * List options - same as search but specifically for iteration.
+ */
+export interface ListOptions extends SearchOptions {
+    /** Page size for iteration (default: 100) */
+    pageSize?: number;
+}
+/**
+ * Search result metadata.
+ */
+export interface SearchMetadata {
+    /** Total count of matching records (if available) */
+    count?: number;
+    /** Current offset */
+    offset?: number;
+    /** Current limit */
+    limit?: number;
+    /** Whether more results are available */
+    has_more?: boolean;
+}
+/**
+ * Search result from the API.
+ */
+export interface SearchResult<T = Record<string, unknown>> {
+    /** Whether the request was successful */
+    success: boolean;
+    /** The model that was searched */
+    model?: string;
+    /** Array of matching records */
+    data?: T[];
+    /** Pagination and count metadata */
+    metadata?: SearchMetadata;
+    /** Error message if success is false */
+    error?: string;
+    /** Warning message if applicable */
+    warning?: string;
+}
+/**
+ * Options for fetching a single resource.
+ */
+export interface FetchOptions {
+    /**
+     * Related models to include in the response.
+     * @example 'supplier,lines,attachments'
+     */
+    includeModels?: string;
+    /**
+     * Related models to exclude from the response.
+     */
+    excludeModels?: string;
+    /**
+     * Specific paths to include.
+     */
+    includePaths?: string;
+    /**
+     * Specific paths to exclude.
+     */
+    excludePaths?: string;
+    /**
+     * Whether to fetch full details.
+     * @default true
+     */
+    fetchDetails?: boolean;
+    /**
+     * Only include active (non-deleted) related records.
+     * @default true
+     */
+    activeOnly?: boolean;
+}
+/**
+ * Result from fetching a single resource.
+ */
+export interface FetchResult<T = Record<string, unknown>> {
+    success: boolean;
+    model?: string;
+    data?: T;
+    error?: string;
+}
+/**
+ * Options for creating a resource.
+ */
+export interface CreateOptions {
+    /** Module context for the new resource */
+    module?: ZudelloModule | string;
+    /** Submodule context for the new resource */
+    submodule?: ZudelloSubmodule | string;
+    /** The data for the new resource */
+    data: Record<string, unknown>;
+    /** Whether to return the created resource */
+    fetch?: boolean;
+    /** Whether to submit for processing after creation */
+    submit?: boolean;
+    /** Whether to enrich with default values */
+    enrich?: boolean;
+    /** Dry run (validate without creating) */
+    dryRun?: boolean;
+}
+/**
+ * Options for updating a resource.
+ */
+export interface UpdateOptions {
+    /** The data to update */
+    data: Record<string, unknown>;
+    /** Whether to return the updated resource */
+    fetch?: boolean;
+    /** Replace entire resource (vs partial update) */
+    replace?: boolean;
+    /** Whether to submit for processing after update */
+    submit?: boolean;
+    /** Update the status field */
+    updateStatus?: boolean;
+    /** Dry run (validate without updating) */
+    dryRun?: boolean;
+}
+/**
+ * Result from create/update operations.
+ */
+export interface MutationResult<T = Record<string, unknown>> {
+    success: boolean;
+    model?: string;
+    data?: T;
+    error?: string;
+    warnings?: string[];
+}
+/**
+ * Options for listing configurations.
+ */
+export interface ConfigListOptions {
+    /** Config type (e.g., 'document_status', 'field_settings') */
+    configType: string;
+    /** Filter by module */
+    module?: ZudelloModule | string;
+    /** Filter by submodule */
+    submodule?: ZudelloSubmodule | string;
+    /** Include global configs */
+    includeGlobal?: boolean;
+}
+/**
+ * Zudello config object.
+ */
+export interface ZudelloConfig {
+    uuid: string;
+    config_type: string;
+    resource_type?: string;
+    version?: string;
+    global_config: boolean;
+    global_resource?: boolean;
+    team_uuid?: string;
+    context: Record<string, string[]> | null;
+    payload: Record<string, unknown>;
+    error?: string | null;
+    created_at: string;
+    updated_at?: string;
+    deleted_at?: string | null;
+}
+/**
+ * Model schema information.
+ */
+export interface ModelSchema {
+    /** Field definitions */
+    fields: Record<string, {
+        type: string;
+        required?: boolean;
+        readonly?: boolean;
+        description?: string;
+        choices?: Array<{
+            value: string;
+            label: string;
+        }>;
+    }>;
+    /** Model relationships */
+    relations?: Record<string, {
+        model: string;
+        type: 'foreign_key' | 'many_to_many' | 'one_to_many';
+    }>;
+}
+/**
+ * Model metadata information.
+ */
+export interface ModelMetadata {
+    /** Display name */
+    display_name?: string;
+    /** Icon identifier */
+    icon?: string;
+    /** Description */
+    description?: string;
+    /** Valid modules for this model */
+    modules?: string[];
+    /** Valid submodules for this model */
+    submodules?: string[];
+}
+/**
+ * Request to fetch a single resource in a batch operation.
+ */
+export interface ResourceFetchRequest {
+    /** The model to fetch (e.g., 'Transaction', 'Supplier') */
+    model: ZudelloModel | string;
+    /** UUID of the resource (either uuid or external_id required) */
+    uuid?: string;
+    /** External ID of the resource (either uuid or external_id required) */
+    external_id?: string;
+    /** Whether to fetch detail records */
+    fetch_details?: boolean;
+    /** Related models to include when fetch_details is true */
+    include_models?: string[];
+    /** Related models to exclude */
+    exclude_models?: string[];
+}
+/**
+ * Options for batch fetch operations.
+ */
+export interface BatchFetchOptions {
+    /** Only return active (non-deleted) instances (default: true) */
+    activeOnly?: boolean;
+    /** Include null/empty values in response (default: true) */
+    includeNulls?: boolean;
+    /** Return simplified flat response format (default: false) */
+    simplified?: boolean;
+}
+/**
+ * Individual result from a batch fetch operation.
+ */
+export interface BatchFetchResult {
+    /** Whether this individual fetch succeeded */
+    success: boolean;
+    /** The model that was fetched */
+    model?: string;
+    /** The fetched data */
+    data?: Record<string, unknown>;
+    /** Error message if this fetch failed */
+    message?: string;
+    /** Detailed errors if applicable */
+    errors?: unknown[];
+}
+/**
+ * Request to update or create a single resource.
+ */
+export interface UpdateOrCreateRequest {
+    /** The data model (e.g., 'Transaction', 'Supplier') */
+    model: ZudelloModel | string;
+    /**
+     * The resource data. Include 'uuid', 'external_id', or 'code' for updates.
+     * Include 'module' and 'submodule' for Transaction model.
+     */
+    data: Record<string, unknown>;
+    /** Fetch the resource in response (cannot be true with update=true) */
+    fetch?: boolean;
+    /** Allow creating if not found (default: true) */
+    create?: boolean;
+    /** Allow updating if found (cannot be true with fetch=true, default: true) */
+    update?: boolean;
+    /** Replace entire resource (true) or merge (false, default: false) */
+    replace?: boolean;
+    /** Submit for processing/workflow (default: false) */
+    submit?: boolean;
+    /** Enrich with additional data (default: false) */
+    enrich?: boolean;
+    /** Test without actual changes (default: false) */
+    dry_run?: boolean;
+}
+/**
+ * Options for batch update or create operations.
+ */
+export interface BatchUpdateOrCreateOptions {
+    /** Queue for batch processing (returns task_id, default: false) */
+    batch?: boolean;
+    /** Return simplified response format (default: false) */
+    simplified?: boolean;
+    /** Test without actual changes (default: false) */
+    dryRun?: boolean;
+    /** Include null values in response (default: true) */
+    includeNulls?: boolean;
+    /** Clear null values from existing record (default: false) */
+    clearNulls?: boolean;
+    /** Migration mode - skips some validations (default: false) */
+    migration?: boolean;
+}
+/**
+ * Individual result from an update or create operation.
+ */
+export interface UpdateOrCreateResult {
+    /** Whether this individual operation succeeded */
+    success: boolean;
+    /** The model that was affected */
+    model?: string;
+    /** The created/updated data */
+    data?: Record<string, unknown>;
+    /** Status message */
+    message?: string;
+    /** Detailed errors if applicable */
+    errors?: unknown[];
+}
+/**
+ * Audit event from resource history.
+ */
+export interface AuditEvent {
+    /** Event UUID */
+    uuid: string;
+    /** Event type (e.g., 'CREATE', 'UPDATE', 'STATUS_CHANGE') */
+    event_type: string;
+    /** Timestamp of the event */
+    timestamp: string;
+    /** User who performed the action */
+    user?: {
+        uuid: string;
+        name?: string;
+        email?: string;
+    };
+    /** Changes made in this event */
+    changes?: Record<string, {
+        old?: unknown;
+        new?: unknown;
+    }>;
+    /** Additional event metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * A Zudello sentence (automation/business rule).
+ *
+ * Sentences define automated workflows triggered by document events.
+ * They consist of conditions and actions that execute when conditions are met.
+ */
+export interface ZudelloSentence {
+    /** Sentence UUID */
+    uuid: string;
+    /** Version string (e.g., '1.0.0') */
+    version?: string;
+    /** Categories/tags for the sentence */
+    categories: string[];
+    /** Execution order (lower runs first). Must be integer. */
+    evalOrder: number;
+    /** Whether the sentence is active */
+    enabled: boolean;
+    /** Whether this is a template */
+    isTemplate: boolean;
+    /** Module this sentence applies to (e.g., 'PURCHASING') */
+    module?: string;
+    /** Submodule filter (e.g., 'INVOICE'). If not set, runs for all submodules. */
+    submodule?: string;
+    /** The recipe defining conditions and actions */
+    recipe: SentenceRecipe;
+    /** Creation timestamp */
+    created_at?: string;
+    /** Last update timestamp */
+    updated_at?: string;
+}
+/**
+ * Recipe structure defining sentence conditions and actions.
+ */
+export interface SentenceRecipe {
+    /** Display name for the sentence */
+    name?: string;
+    /** Event types that trigger this sentence */
+    event_type?: string[];
+    /** Blocks of conditions and actions */
+    blocks?: SentenceBlock[];
+}
+/**
+ * A block within a sentence recipe containing conditions and actions.
+ */
+export interface SentenceBlock {
+    /** Conditions that must be met for actions to execute */
+    conditions?: SentenceCondition[];
+    /** Actions to execute when conditions are met */
+    actions?: SentenceAction[];
+}
+/**
+ * A condition in a sentence.
+ */
+export interface SentenceCondition {
+    /** Condition type (e.g., 'CUSTOM_CONDITION') */
+    type: string;
+    /** The field to evaluate */
+    field?: {
+        value: string;
+        meta?: {
+            path?: string;
+            sentence_path?: string;
+            type?: string;
+        };
+    };
+    /** The comparison operator */
+    operator?: {
+        value: string;
+        use?: string | null;
+        meta?: Record<string, unknown>;
+    };
+    /** The value to compare against */
+    value?: unknown;
+}
+/**
+ * An action in a sentence.
+ */
+export interface SentenceAction {
+    /** Action type (e.g., 'SET_STATUS', 'GET_APPROVAL', 'CANCEL_PROCESSING') */
+    type: string;
+    /** Action parameters (varies by type) */
+    params?: Record<string, unknown>;
+    /** Whether this is a fallback/otherwise action */
+    otherwise?: boolean;
+}
+/**
+ * Options for listing sentences.
+ */
+export interface ListSentencesOptions {
+    /** Filter by submodule */
+    submodule?: string;
+    /** Filter to templates only */
+    isTemplate?: boolean;
+    /** Filter by enabled status */
+    enabled?: boolean;
+    /** Filter by trigger event types */
+    triggers?: string[];
+    /** Filter by fields used */
+    fields?: string[];
+    /** Filter by action types */
+    actions?: string[];
+    /** Page number for pagination */
+    page?: number;
+    /** Results per page */
+    perPage?: number;
+}
+/**
+ * Sentence resource (action or condition template).
+ */
+export interface SentenceResource {
+    /** Resource UUID */
+    uuid: string;
+    /** Resource type */
+    resource_type: string;
+    /** Resource payload */
+    payload: {
+        code: string;
+        name: string;
+        template: string;
+        field?: Record<string, unknown>;
+        values?: unknown[];
+        operator?: Record<string, unknown>;
+    };
+}
+/**
+ * Payload for creating a sentence.
+ */
+export interface CreateSentencePayload {
+    /** Optional version (defaults to 1.0.0) */
+    version?: string;
+    /** Optional UUID (auto-generated if not provided) */
+    uuid?: string;
+    /** Categories/tags */
+    categories: string[];
+    /** Execution order (must be integer) */
+    evalOrder: number;
+    /** Whether enabled */
+    enabled: boolean;
+    /** Whether this is a template */
+    isTemplate: boolean;
+    /** The recipe with conditions and actions */
+    recipe: SentenceRecipe;
+}
+/**
+ * An integration script.
+ */
+export interface ZudelloScript {
+    /** Script UUID */
+    uuid: string;
+    /** Script name */
+    name: string;
+    /** File path in the integration repo */
+    file_path: string;
+    /** Script content (when fetched individually) */
+    file_content?: string;
+    /** Whether this is a global script */
+    global: boolean;
+}
+/**
+ * A trigger definition.
+ */
+export interface ZudelloTrigger {
+    /** Trigger UUID */
+    uuid: string;
+    /** Trigger name */
+    name: string;
+    /** Whether enabled */
+    enabled: boolean;
+    /** Trigger type (e.g., 'SCHEDULE', 'WEBHOOK', 'EVENT') */
+    type: string;
+    /** Associated script UUID */
+    script_uuid?: string;
+    /** Schedule configuration (for SCHEDULE type) */
+    schedule?: {
+        cron?: string;
+        interval?: number;
+        timezone?: string;
+    };
+    /** Event configuration (for EVENT type) */
+    event?: {
+        module?: string;
+        submodule?: string;
+        event_type?: string;
+    };
+}
+/**
+ * Options for listing triggers.
+ */
+export interface ListTriggersOptions {
+    /** Filter by enabled status */
+    enabled?: boolean;
+    /** Filter by trigger type */
+    type?: string;
+    /** Filter by module */
+    module?: string;
+    /** Page number */
+    page?: number;
+    /** Results per page */
+    perPage?: number;
+}
+/**
+ * Automation log entry.
+ */
+export interface AutomationLog {
+    /** Log UUID */
+    uuid: string;
+    /** Associated trigger UUID */
+    trigger_uuid: string;
+    /** Run status */
+    status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED';
+    /** Start timestamp */
+    started_at?: string;
+    /** End timestamp */
+    completed_at?: string;
+    /** Error message if failed */
+    error?: string;
+    /** Additional run metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Options for fetching automation logs.
+ */
+export interface GetAutomationLogsOptions {
+    /** Filter by trigger UUID */
+    triggerUuid?: string;
+    /** Filter by status */
+    status?: string;
+    /** Filter by date range start */
+    startDate?: string;
+    /** Filter by date range end */
+    endDate?: string;
+    /** Page number */
+    page?: number;
+    /** Results per page */
+    perPage?: number;
+}
+/**
+ * Run log entry.
+ */
+export interface RunLog {
+    /** Log UUID */
+    uuid: string;
+    /** Log timestamp */
+    timestamp: string;
+    /** Log level */
+    level: 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
+    /** Log message */
+    message: string;
+    /** Additional context */
+    context?: Record<string, unknown>;
+}
+/**
+ * Options for searching runs.
+ */
+export interface SearchRunsOptions {
+    /** Filter by trigger UUID */
+    triggerUuid?: string;
+    /** Filter by status */
+    status?: string;
+    /** Filter by date range start */
+    startDate?: string;
+    /** Filter by date range end */
+    endDate?: string;
+    /** Search in error messages */
+    errorContains?: string;
+    /** Page number */
+    page?: number;
+    /** Results per page */
+    perPage?: number;
+}
+/**
+ * Approval action for bulk milestone operations.
+ */
+export interface ApprovalItem {
+    /** Milestone UUID */
+    milestone_uuid: string;
+    /** Action to take */
+    action: 'APPROVE' | 'REJECT';
+    /** Optional comment */
+    comment?: string;
+}
+/**
+ * Result of a bulk approval operation.
+ */
+export interface BulkApprovalResult {
+    /** Whether the operation succeeded */
+    success: boolean;
+    /** Results for each approval */
+    data: Array<{
+        success: boolean;
+        message: string;
+    }>;
+}
+/**
+ * A user group in Zudello.
+ */
+export interface UserGroup {
+    /** Group UUID */
+    uuid: string;
+    /** Group name */
+    name: string;
+    /** Group description */
+    description: string;
+    /** Group status */
+    status: string;
+    /** Group type */
+    user_group_type: string;
+    /** Team user IDs in this group */
+    team_user_ids: string[];
+}
+/**
+ * A team user in Zudello.
+ */
+export interface TeamUser {
+    /** User UUID */
+    uuid: string;
+    /** First name */
+    first_name: string;
+    /** Last name */
+    last_name: string;
+    /** Email address */
+    email: string;
+    /** User status */
+    status: string;
+}
+/**
+ * Options for listing user groups.
+ */
+export interface GetUserGroupsOptions {
+    /** Filter by status */
+    status?: string;
+    /** Filter by group type */
+    userGroupType?: string;
+    /** Search term */
+    search?: string;
+    /** Name pattern filter */
+    namePattern?: string;
+    /** Include member IDs (default: false for performance) */
+    includeMemberIds?: boolean;
+    /** Results limit */
+    limit?: number;
+    /** Results offset */
+    offset?: number;
+}
+/**
+ * Options for listing users.
+ */
+export interface GetUsersOptions {
+    /** Filter by status */
+    status?: string;
+    /** Search term */
+    search?: string;
+    /** Name pattern filter */
+    namePattern?: string;
+    /** Email domain filter */
+    emailDomain?: string;
+    /** Results limit */
+    limit?: number;
+    /** Results offset */
+    offset?: number;
+}
+/**
+ * Editor type for dataset columns.
+ */
+export type DatasetEditorType = 'TEXT' | 'NUMERIC' | 'DD_SINGLE' | 'DD_MULTIPLE' | 'DATE';
+/**
+ * Column definition for a dataset.
+ */
+export interface DatasetColumnDef {
+    /** Column ID (auto-generated if not provided) */
+    colId?: string;
+    /** Field name */
+    field: string;
+    /** Column header display name */
+    headerName: string;
+    /** Editor configuration */
+    editor: {
+        type: DatasetEditorType;
+        select?: {
+            label: string;
+            source: 'STORAGE';
+            storage: {
+                getter: string;
+            };
+            trackBy: string;
+        };
+        placeholder?: string;
+    };
+    /** Root path for dimension matching (e.g., 'lines', 'supplier', '') */
+    rootPath?: string;
+    /** Approval field type */
+    approvalField?: 'step_name' | 'user' | 'user_group' | 'limit' | 'manager' | 'dimension' | '';
+    /** Whether the column is read-only */
+    readonly?: boolean;
+    /** Whether this column has checkbox selection */
+    checkboxSelection?: boolean;
+    /** Whether this is the default label column */
+    isDefaultLabel?: boolean;
+    /** Whether this is the default track-by column */
+    isDefaultTrackBy?: boolean;
+}
+/**
+ * Dataset settings structure.
+ */
+export interface DatasetSettings {
+    /** Column definitions */
+    columnDefs: DatasetColumnDef[];
+    /**
+     * Dataset type for approval workflows.
+     * - '' (empty): Generic lookup/mapping tables
+     * - 'approval_doa': Delegation of Authority
+     * - 'approval_doa_group': DOA using user groups
+     * - 'approval_management_tree': Manager hierarchy
+     * - 'approval_user_limit': User-specific approval limits
+     */
+    datasetType: string;
+    /**
+     * How to handle dimension mismatches:
+     * - 'fail_sentence': Stop sentence if no match
+     * - 'skip_sentence': Skip to next sentence
+     * - 'skip_line': Skip non-matching lines
+     */
+    on_dimension_mismatch?: 'fail_sentence' | 'skip_sentence' | 'skip_line';
+}
+/**
+ * Full dataset resource.
+ */
+export interface ZudelloDataset {
+    /** Version string */
+    version: string;
+    /** Creation timestamp */
+    created_at: string;
+    /** Last update timestamp */
+    updated_at: string;
+    /** Deletion timestamp (null if active) */
+    deleted_at: string | null;
+    /** Dataset UUID */
+    uuid: string;
+    /** Team UUID */
+    team_uuid: string;
+    /** Whether this is a global resource */
+    global_resource: boolean;
+    /** Resource type (always 'dataset') */
+    resource_type: 'dataset';
+    /** Context configuration */
+    context: Record<string, unknown> | null;
+    /** Dataset payload */
+    payload: {
+        uuid?: string;
+        name: string;
+        settings: DatasetSettings;
+    };
+    /** Error message if any */
+    error: string | null;
+}
+/**
+ * Simplified dataset summary for listing.
+ */
+export interface DatasetSummary {
+    /** Dataset UUID */
+    uuid: string;
+    /** Dataset name */
+    name: string;
+    /** Dataset type */
+    datasetType: string;
+    /** Column definitions (included if requested) */
+    columnDefs?: DatasetColumnDef[];
+}
+/**
+ * Notification type definition.
+ */
+export interface NotificationType {
+    /** Type key */
+    key: string;
+    /** Display name */
+    name: string;
+    /** Description */
+    description?: string;
+    /** Category */
+    category?: string;
+}
+/**
+ * User notification preference.
+ */
+export interface NotificationPreference {
+    /** Notification type key */
+    notification_type: string;
+    /** Whether email notifications are enabled */
+    email_enabled: boolean;
+    /** Whether in-app notifications are enabled */
+    inapp_enabled: boolean;
+    /** User UUID */
+    user_uuid?: string;
+}
+/**
+ * Language placeholder entry for entity naming.
+ */
+export interface LanguagePlaceholderEntry {
+    /** Singular form (e.g., 'Invoice') */
+    singular: string;
+    /** Plural form (e.g., 'Invoices') */
+    plural: string;
+    /** Linked model name */
+    linkedModel: string;
+}
+/**
+ * Language placeholders resource.
+ */
+export interface LanguagePlaceholdersResource {
+    /** Resource UUID */
+    uuid: string;
+    /** Version */
+    version: string;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+    /** Team UUID */
+    team_uuid: string;
+    /** Whether global */
+    global_resource: boolean;
+    /** Resource type */
+    resource_type: string;
+    /** Context */
+    context: unknown | null;
+    /** Language entries by key */
+    payload: {
+        lang: Record<string, LanguagePlaceholderEntry>;
+    };
+    /** Error if any */
+    error: string | null;
+}
+/**
+ * Full inbox resource.
+ */
+export interface ZudelloInbox {
+    /** Inbox UUID */
+    uuid: string;
+    /** Inbox name */
+    name: string;
+    /** Mailbox address (local part) */
+    mailbox: string;
+    /** Reply-to address */
+    reply_to_address: string | null;
+    /** Custom send domain */
+    custom_send_domain: string | null;
+    /** Custom send mailbox */
+    custom_send_mailbox: string | null;
+    /** Default BCC list */
+    default_bcc_list: string | null;
+    /** Default CC list */
+    default_cc_list: string | null;
+    /** Resource module */
+    resource_module: string;
+    /** Subsidiary UUID */
+    subsidiary: string | null;
+    /** Location UUID */
+    location: string | null;
+    /** Inbox type */
+    inbox_type: string;
+    /** Module */
+    module: string;
+    /** Submodule */
+    submodule: string;
+    /** Whether to extract email body */
+    extract_email_body: boolean;
+    /** Status */
+    status: string;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+}
+/**
+ * Inbox summary for listing.
+ */
+export interface InboxSummary {
+    /** Inbox UUID */
+    uuid: string;
+    /** Inbox name */
+    name: string;
+    /** Mailbox address */
+    mailbox: string;
+    /** Reply-to address */
+    reply_to_address: string | null;
+    /** Full email address (computed) */
+    fullEmailAddress?: string;
+}
+/**
+ * Request to create an inbox.
+ */
+export interface CreateInboxRequest {
+    /** Inbox name */
+    name: string;
+    /** Mailbox address (local part before @) */
+    mailbox: string;
+    /** Resource module */
+    resource_module: string;
+    /** Subsidiary UUID (optional) */
+    subsidiary_uuid?: string;
+    /** Location UUID (optional) */
+    location_uuid?: string;
+}
+/**
+ * Request to update an inbox.
+ */
+export interface UpdateInboxRequest {
+    /** Inbox UUID */
+    uuid: string;
+    /** Inbox name */
+    name?: string;
+    /** Mailbox address */
+    mailbox?: string;
+    /** Resource module */
+    resource_module?: string;
+    /** Reply-to address */
+    reply_to_address?: string | null;
+    /** Default BCC list */
+    default_bcc_list?: string | null;
+    /** Default CC list */
+    default_cc_list?: string | null;
+    /** Subsidiary UUID */
+    subsidiary_uuid?: string | null;
+    /** Location UUID */
+    location_uuid?: string | null;
+    /** Whether to extract email body */
+    extract_email_body?: boolean;
+}
+/**
+ * Line item for budget check.
+ */
+export interface BudgetCheckLineItem {
+    /** Account UUID */
+    account_id: string;
+    /** Amount */
+    amount: number;
+    /** Currency UUID */
+    currency_id: string;
+    /** Department UUID (optional) */
+    department_id?: string;
+    /** Location UUID (optional) */
+    location_id?: string;
+    /** Project UUID (optional) */
+    project_id?: string;
+    /** Subsidiary UUID (optional) */
+    subsidiary_id?: string;
+}
+/**
+ * Request to check document budgets.
+ */
+export interface BudgetCheckRequest {
+    /** Module (e.g., 'PURCHASING') */
+    module: string;
+    /** Submodule (e.g., 'INVOICE') */
+    submodule: string;
+    /** Transaction UUID (optional for new documents) */
+    transaction_uuid?: string;
+    /** Date to check budgets against */
+    date_issued: string;
+    /** Line items to check */
+    lines: BudgetCheckLineItem[];
+}
+/**
+ * Result of a budget check for a line.
+ */
+export interface BudgetCheckResult {
+    /** Budget line UUID */
+    budget_line_uuid: string;
+    /** Budget UUID */
+    budget_uuid: string;
+    /** Budget name */
+    budget_name: string;
+    /** Budget line name */
+    budget_line_name: string;
+    /** Whether the line passed budget check */
+    passed: boolean;
+    /** Budget amount in local currency */
+    budget_local: number;
+    /** Remaining budget */
+    remaining_local: number;
+    /** Budget owner UUIDs */
+    budget_owner_uuids: string[];
+    /** Budget line owner UUIDs */
+    budget_line_owner_uuids: string[];
+    /** Transaction line UUIDs */
+    transaction_line_uuids: string[];
+}
+/**
+ * Line item for contract pricing check.
+ */
+export interface ContractPricingLineItem {
+    /** Item UUID */
+    item_id?: string;
+    /** Purchase price */
+    purchase_price?: number;
+    /** Unit price */
+    unit_price?: number;
+    /** Unit price exclusive of tax */
+    unit_price_exclusive?: number;
+    /** Currency UUID */
+    currency_id?: string;
+    /** Project UUID */
+    project_id?: string;
+}
+/**
+ * Request to check contract pricings.
+ */
+export interface ContractPricingRequest {
+    /** Module (e.g., 'PURCHASING') */
+    module: string;
+    /** Submodule (e.g., 'INVOICE') */
+    submodule: string;
+    /** Date to check contracts against */
+    date_issued: string;
+    /** Supplier UUID (for purchasing) */
+    supplier_id?: string;
+    /** Customer UUID (for sales) */
+    customer_id?: string;
+    /** Line items to check */
+    lines: ContractPricingLineItem[];
+}
+/**
+ * Result of contract pricing check.
+ */
+export interface ContractPricingResult {
+    /** Contract UUID */
+    contract_uuid: string;
+    /** Contract name */
+    contract_name: string;
+    /** Contract owner UUIDs */
+    owner_uuids: string[];
+    /** Contract effective date */
+    effective_at: string;
+    /** Contract expiry date */
+    expiry_at: string;
+    /** Pricing results for each line */
+    contract_pricings: Array<{
+        /** Exception type */
+        exception: 'NONE' | 'PRICE_VARIANCE' | 'NOT_ON_CONTRACT' | 'EXPIRED';
+        /** Contract price (null if not on contract) */
+        price: number | null;
+    }>;
+}
+/**
+ * Organisation team structure.
+ *
+ * Represents a team within an organisation in Zudello.
+ * Teams are workspaces that contain users, data, and configurations.
+ */
+export interface OrgTeam {
+    /** Team UUID */
+    uuid: string;
+    /** Team name */
+    name: string;
+    /** Trading name (optional) */
+    trading_name: string | null;
+    /** Tax identification number */
+    tax_number: string | null;
+    /** Contact email */
+    email: string | null;
+    /** Contact phone */
+    phone: string | null;
+    /** Website URL */
+    website: string | null;
+    /** Logo URL */
+    logo: string | null;
+    /** Team type */
+    team_type: 'PRODUCTION' | 'SANDBOX' | 'DEMO';
+    /** Whether notifications are disabled */
+    disable_notifications: boolean;
+    /** Team status */
+    status: 'ACTIVE' | 'INACTIVE';
+    /** Country information */
+    country: {
+        uuid: string;
+        name: string;
+        code?: string;
+    } | null;
+    /** Timezone information */
+    timezone: {
+        uuid: string;
+        code: string;
+    } | null;
+    /** Currency information */
+    currency: {
+        uuid: string;
+        code: string;
+        name?: string;
+        symbol?: string;
+    } | null;
+    /** Cluster information */
+    cluster: {
+        uuid: string;
+        name: string;
+        url: string;
+    } | null;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+}
+/**
+ * Options for listing organisation teams.
+ */
+export interface ListOrgTeamsOptions {
+    /** Maximum number of results */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/**
+ * Request to update an organisation team.
+ */
+export interface UpdateOrgTeamRequest {
+    /** Team name */
+    name?: string;
+    /** Trading name */
+    trading_name?: string;
+    /** Tax identification number */
+    tax_number?: string;
+    /** Contact email */
+    email?: string;
+    /** Contact phone */
+    phone?: string;
+    /** Website URL */
+    website?: string;
+    /** Team type */
+    team_type?: 'PRODUCTION' | 'SANDBOX' | 'DEMO';
+    /** Disable notifications */
+    disable_notifications?: boolean;
+    /** Country UUID */
+    country_id?: string;
+    /** Currency UUID */
+    currency_id?: string;
+    /** Timezone UUID */
+    timezone_id?: string;
+}
+/**
+ * Organisation user structure.
+ *
+ * Represents a user within an organisation, including their team assignments
+ * and organisation-level permissions.
+ */
+export interface OrgUser {
+    /** User UUID */
+    uuid: string;
+    /** First name */
+    first_name: string;
+    /** Last name */
+    last_name: string;
+    /** Email address */
+    email: string;
+    /** Avatar URL */
+    avatar: string | null;
+    /** User status */
+    status: 'ACTIVE' | 'INACTIVE';
+    /** Whether this is a machine/service account */
+    is_machine: boolean;
+    /** Zitadel identity provider ID */
+    zitadel_id: number | null;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+    /** Organisation memberships */
+    organizations?: Array<{
+        uuid: string;
+        name: string;
+        through__is_admin: boolean;
+        through__status: string;
+    }>;
+    /** Team memberships */
+    teams?: Array<{
+        uuid: string;
+        name: string;
+        through__uuid: string;
+        through__status: string;
+        through__groups: string[];
+    }>;
+    /** TeamUser assignments (detailed) */
+    teamuser_set?: TeamUserAssignment[];
+    /** OrganizationUser assignments */
+    organizationuser_set?: Array<{
+        uuid: string;
+        is_admin: boolean;
+        is_owner: boolean;
+        status: string;
+    }>;
+}
+/**
+ * Team-user assignment structure.
+ *
+ * Represents the relationship between a user and a team,
+ * including their groups, delegation settings, and defaults.
+ */
+export interface TeamUserAssignment {
+    /** Assignment UUID */
+    uuid: string;
+    /** Team UUID */
+    team: string;
+    /** User UUID */
+    user: string;
+    /** Assignment status */
+    status: 'ACTIVE' | 'INACTIVE';
+    /** Whether this is the user's default team */
+    is_default: boolean;
+    /** Manager user UUID */
+    manager: string | null;
+    /** Whether to delegate all duties */
+    delegate_all: boolean;
+    /** Whether delegation is enabled */
+    delegate_duties: boolean;
+    /** User UUID to delegate to */
+    delegate_to_user: string | null;
+    /** Delegation start date (ISO string) */
+    delegate_start: string | null;
+    /** Delegation end date (ISO string) */
+    delegate_end: string | null;
+    /** Default subsidiary UUID */
+    default_subsidiary: string | null;
+    /** Default location UUID */
+    default_location: string | null;
+    /** User groups for this team */
+    groups: Array<{
+        uuid: string;
+    }> | string[];
+    /** Creation timestamp */
+    created_at?: string;
+    /** Update timestamp */
+    updated_at?: string;
+}
+/**
+ * Options for listing organisation users.
+ */
+export interface ListOrgUsersOptions {
+    /** Filter by status */
+    status?: 'ACTIVE' | 'INACTIVE';
+    /** Search term (searches name and email) */
+    search?: string;
+    /** Maximum number of results */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/**
+ * Request to create a new organisation user.
+ */
+export interface CreateOrgUserRequest {
+    /** First name */
+    first_name: string;
+    /** Last name */
+    last_name: string;
+    /** Email address */
+    email: string;
+    /** Initial password (optional) */
+    password?: string;
+    /** Whether email is pre-verified (default: true) */
+    is_email_verified?: boolean;
+}
+/**
+ * Request to update an organisation user.
+ */
+export interface UpdateOrgUserRequest {
+    /** First name */
+    first_name?: string;
+    /** Last name */
+    last_name?: string;
+}
+/**
+ * Request to assign a user to a team.
+ */
+export interface AssignUserToTeamRequest {
+    /** Existing TeamUser UUID (for updates) */
+    teamUserUuid?: string;
+    /** Team UUID */
+    teamId: string;
+    /** User UUID */
+    userId: string;
+    /** Organisation UUID */
+    orgId: string;
+    /** User group UUIDs to assign */
+    groups?: string[];
+    /** Manager user UUID */
+    managerId?: string;
+    /** Whether this is the user's default team */
+    isDefault?: boolean;
+    /** Assignment status */
+    status?: 'ACTIVE' | 'INACTIVE';
+    /** Default subsidiary UUID */
+    defaultSubsidiary?: string;
+    /** Default location UUID */
+    defaultLocation?: string;
+    /** Whether to delegate all duties */
+    delegateAll?: boolean;
+    /** Whether delegation is enabled */
+    delegateDuties?: boolean;
+    /** User UUID to delegate to */
+    delegateToUserId?: string;
+    /** Delegation start date (ISO string) */
+    delegateStart?: string;
+    /** Delegation end date (ISO string) */
+    delegateEnd?: string;
+}
+/**
+ * Organisation user group structure.
+ *
+ * User groups define access control and approval workflow participation.
+ */
+export interface OrgUserGroup {
+    /** Group UUID */
+    uuid: string;
+    /** Group name */
+    name: string;
+    /** Group description */
+    description: string;
+    /** Whether users in this group can delegate */
+    can_delegate: boolean;
+    /** Group status */
+    status: 'ACTIVE' | 'INACTIVE';
+    /**
+     * Group type:
+     * - ACCESS: Controls feature/module access
+     * - APPROVAL: Used in approval workflows
+     * - LEGACY: Deprecated group type
+     */
+    user_group_type: 'ACCESS' | 'APPROVAL' | 'LEGACY';
+    /** Count of permissions assigned */
+    permissions_count?: number;
+    /** Team users in this group */
+    team_users?: Array<{
+        uuid: string;
+    }> | null;
+}
+/**
+ * Options for listing organisation user groups.
+ */
+export interface ListOrgUserGroupsOptions {
+    /** Filter by status */
+    status?: 'ACTIVE' | 'INACTIVE';
+    /** Filter by group type */
+    userGroupType?: 'ACCESS' | 'APPROVAL' | 'LEGACY';
+    /** Search term (searches name and description) */
+    search?: string;
+    /** Include team user IDs in response */
+    includeTeamUsers?: boolean;
+    /** Maximum number of results */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/**
+ * Filter for dropdown select options.
+ */
+export interface FieldSettingsSelectFilter {
+    /** Field to filter on */
+    field: string;
+    /** Value(s) to match */
+    value: string | string[];
+    /** Comparison operator */
+    operator: 'EQUAL' | 'NOT_EQUAL' | 'CONTAINS' | 'NOT_CONTAINS' | null;
+}
+/**
+ * Editor select configuration for dropdowns.
+ */
+export interface FieldSettingsSelectConfig {
+    /** Display format string (e.g., '{code} - {name}', 'name') */
+    label: string;
+    /** Data source type */
+    source: 'STORAGE' | 'DATASET';
+    /** Storage configuration (when source=STORAGE) */
+    storage?: {
+        getter: string;
+    };
+    /** Dataset configuration (when source=DATASET) */
+    dataset?: {
+        uuid: string | null;
+    };
+    /** Field to track by (usually 'uuid' or 'value') */
+    trackBy: string;
+    /** Include ERP value in response */
+    withErpValue?: boolean;
+    /** Filtering options */
+    filters?: FieldSettingsSelectFilter[];
+}
+/**
+ * Editor configuration for a field.
+ */
+export interface FieldSettingsEditor {
+    /** Editor type */
+    type: 'TEXT' | 'NUMERIC' | 'BOOLEAN' | 'DATE' | 'DD_SINGLE' | 'DD_MULTIPLE';
+    /** Placeholder text */
+    placeholder?: string;
+    /** Input mask (for TEXT, e.g., 'XXX-XX-XXXX', '######') */
+    mask?: string;
+    /** Numeric configuration (for NUMERIC) */
+    numeric?: {
+        precision: number;
+    };
+    /** Default value */
+    default?: boolean | string | number | unknown[];
+    /** Select configuration (for DD_SINGLE/DD_MULTIPLE) */
+    select?: FieldSettingsSelectConfig;
+}
+/**
+ * Validation rule parameters.
+ */
+export interface FieldSettingsValidationParams {
+    /** Value for maxLength/minLength */
+    value?: number;
+    /** Path for requiredIf */
+    path?: string;
+    /** Condition operator (e.g., '==') */
+    condition?: string;
+    /** Category for requiredIf */
+    category?: string;
+    /** Subcategory for requiredIf */
+    subcategory?: string;
+}
+/**
+ * Validation rule for a field.
+ */
+export interface FieldSettingsValidation {
+    /** Validation type */
+    key: 'required' | 'requiredIf' | 'number' | 'maxLength' | 'minLength';
+    /** Validation severity */
+    level: 'error' | 'warning' | 'info';
+    /** Validation parameters */
+    params: FieldSettingsValidationParams;
+}
+/**
+ * Display/behavior rule parameters.
+ */
+export interface FieldSettingsRuleParams {
+    /** Path for visibleIf */
+    path?: string;
+    /** Value for visibleIf */
+    value?: string;
+    /** Condition for visibleIf */
+    condition?: string;
+    /** Category for visibleIf */
+    category?: string;
+    /** Subcategory for visibleIf */
+    subcategory?: string;
+    /** Template for computeField */
+    template?: string;
+    /** Counter key for computeField */
+    counterKey?: string;
+}
+/**
+ * Display/behavior rule.
+ */
+export interface FieldSettingsRule {
+    /** Rule type */
+    name: 'visibleIf' | 'computeField';
+    /** Rule parameters */
+    params: FieldSettingsRuleParams;
+}
+/**
+ * Form data structure for field settings.
+ */
+export interface FieldSettingsFormData {
+    /** Editor configuration */
+    editor: FieldSettingsEditor;
+    /** Tooltip text */
+    tooltip: string;
+    /** Validation rules */
+    validations: FieldSettingsValidation[];
+    /** Display/behavior rules */
+    rules: FieldSettingsRule[];
+}
+/**
+ * Payload for field settings resource.
+ */
+export interface FieldSettingsPayload {
+    /** Field path (e.g., 'supplier.trading_name') */
+    path: string;
+    /** UUID (set after creation) */
+    uuid?: string;
+    /** Display label */
+    label: string;
+    /** Model name this field belongs to */
+    model_name: string;
+    /** Form data with editor and validation config */
+    form_data: FieldSettingsFormData;
+}
+/**
+ * Full field settings resource.
+ */
+export interface ZudelloFieldSettings {
+    /** Resource version */
+    version: number;
+    /** Resource UUID */
+    uuid: string;
+    /** Team UUID */
+    team_uuid: string;
+    /** Context (module -> submodule[] mapping) */
+    context: Record<string, string[]>;
+    /** Field settings payload */
+    payload: FieldSettingsPayload;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+    /** Whether this is a global resource */
+    global_resource: boolean;
+    /** Resource type */
+    resource_type: 'field_settings';
+    /** Error message if any */
+    error: string | null;
+}
+/**
+ * Simplified field settings for listing.
+ */
+export interface FieldSettingsSummary {
+    /** Resource UUID */
+    uuid: string;
+    /** Field path */
+    path: string;
+    /** Display label */
+    label: string;
+    /** Model name */
+    model_name: string;
+    /** Context mapping */
+    context: Record<string, string[]>;
+}
+/**
+ * Payload for document status resource.
+ */
+export interface DocumentStatusPayload {
+    /** Status key (e.g., 'REVIEW', 'APPROVED') */
+    key: string;
+    /** Display name */
+    name: string;
+    /** Status type */
+    type: string;
+    /** Color code (hex or name) */
+    color: string;
+    /** Whether the status is enabled */
+    isEnabled: boolean;
+    /** Whether the status is selected by default */
+    isSelected: boolean;
+    /** Whether users can manually set this status */
+    canSetManually: boolean;
+    /** Display order */
+    order: number;
+    /** UUID (set after creation) */
+    uuid?: string;
+}
+/**
+ * Full document status resource.
+ */
+export interface ZudelloDocumentStatus {
+    /** Resource version */
+    version: string;
+    /** Resource UUID */
+    uuid: string;
+    /** Team UUID */
+    team_uuid: string;
+    /** Context (module -> submodule[] mapping) */
+    context: Record<string, string[]>;
+    /** Status payload */
+    payload: DocumentStatusPayload;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+    /** Whether this is a global resource */
+    global_resource: boolean;
+    /** Resource type */
+    resource_type: 'document_status';
+    /** Error message if any */
+    error: string | null;
+}
+/**
+ * Options for listing document statuses.
+ */
+export interface ListStatusesOptions {
+    /** Filter by module */
+    module?: string;
+    /** Filter by submodule */
+    submodule?: string;
+    /** Paths to include */
+    includePaths?: string[];
+}
+/**
+ * Payload for quick action resource.
+ */
+export interface QuickActionPayload {
+    /** Action key (unique identifier) */
+    key: string;
+    /** Display name */
+    name: string;
+    /** Keyboard shortcut */
+    hotkey?: string;
+    /** Status filter */
+    status?: string;
+    /** Context (module/submodule scope) */
+    context?: Record<string, string[]>;
+    /** Whether this is an internal action */
+    isInternal?: boolean;
+}
+/**
+ * Full quick action resource.
+ */
+export interface ZudelloQuickAction {
+    /** Resource version */
+    version: string;
+    /** Resource UUID */
+    uuid: string;
+    /** Team UUID */
+    team_uuid: string;
+    /** Context (quick actions have context inside payload) */
+    context: null;
+    /** Quick action payload */
+    payload: QuickActionPayload;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+    /** Whether this is a global resource */
+    global_resource: boolean;
+    /** Resource type */
+    resource_type: 'quick_actions';
+    /** Error message if any */
+    error: string | null;
+}
+/**
+ * Response from triggering a quick action.
+ */
+export interface QuickActionTriggerResponse {
+    /** Whether the trigger succeeded */
+    success: boolean;
+    /** Status message */
+    status: string;
+    /** UUIDs of successfully processed documents */
+    succeeded: string[];
+    /** UUIDs of failed documents */
+    failed: string[];
+}
+/**
+ * Export filter structure.
+ */
+export interface ExportFilter {
+    /** Field to filter on */
+    field: string;
+    /** Field data type */
+    fieldType: 'String' | 'Number' | 'Date' | 'DateTime' | 'Relation';
+    /** Filter operator */
+    operator: string;
+    /** Filter value */
+    value: unknown;
+}
+/**
+ * Payload for export template resource.
+ */
+export interface ExportTemplatePayload {
+    /** Template UUID (empty for new templates) */
+    uuid?: string;
+    /** Template name */
+    name: string;
+    /** Export type */
+    export_type: 'csv' | 'originals';
+    /** Model to export */
+    model_name: string;
+    /** Module filter */
+    module: string;
+    /** Submodule filter */
+    submodule: string;
+    /** Raw filter conditions */
+    raw_filter: ExportFilter[];
+    /** Fields to include in export */
+    selected_fields: string[];
+}
+/**
+ * Full export template resource.
+ */
+export interface ZudelloExportTemplate {
+    /** Resource version */
+    version: string;
+    /** Resource UUID */
+    uuid: string;
+    /** Team UUID */
+    team_uuid: string;
+    /** Context (export templates have null context) */
+    context: null;
+    /** Export template payload */
+    payload: ExportTemplatePayload;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+    /** Whether this is a global resource */
+    global_resource: boolean;
+    /** Resource type */
+    resource_type: 'export_template';
+    /** Error message if any */
+    error: string | null;
+}
+/**
+ * Data export record (from search results).
+ */
+export interface ZudelloDataExport {
+    /** Export UUID */
+    uuid: string;
+    /** User who created the export */
+    created_by: {
+        uuid: string;
+    };
+    /** Creation timestamp */
+    created_at: string;
+    /** Export status */
+    status: string;
+    /** S3 location */
+    s3_location: string;
+    /** Number of times downloaded */
+    download_count: number;
+    /** Template name used */
+    template_name: string;
+}
+/**
+ * Request to run an export.
+ */
+export interface ExportRunRequest {
+    /** Model to export */
+    model: string;
+    /** Fields to select */
+    select: string[];
+    /** Filter criteria */
+    filter: Record<string, unknown>;
+    /** Exclusion criteria */
+    exclude?: Record<string, unknown>;
+    /** Offset for pagination */
+    offset?: number;
+    /** Limit for pagination */
+    limit?: number;
+}
+/**
+ * Document type field definition.
+ */
+export interface DocumentTypeField {
+    /** Field path */
+    path: string;
+    /** Display label */
+    label: string;
+    /** Validation rules */
+    rules: unknown[] | null;
+    /** Editor configuration */
+    editor: {
+        type: string;
+        select?: {
+            label: string;
+            source: string;
+            storage?: {
+                getter: string;
+            };
+            trackBy: string;
+            params?: Record<string, unknown>;
+            filters?: unknown[];
+        };
+        subtype?: string;
+        placeholder?: string;
+        default?: unknown;
+        numeric?: {
+            precision: number;
+        };
+    };
+    /** Section configuration */
+    section: {
+        key: string;
+        cols: number;
+        order: number;
+    };
+    /** Tooltip text */
+    tooltip: string | null;
+    /** Whether field is visible */
+    visible: boolean;
+    /** Whether field is editable */
+    editable: boolean;
+    /** Renderer configuration */
+    renderer: {
+        width?: number;
+        align?: string;
+        horizontal?: boolean;
+        break?: {
+            after?: boolean;
+            before?: boolean;
+        };
+    };
+    /** Validation definitions */
+    validations: Array<{
+        key: string;
+        level: string;
+        params: Record<string, unknown>;
+    }> | null;
+}
+/**
+ * Document type section definition.
+ */
+export interface DocumentTypeSection {
+    /** Section key */
+    key: string;
+    /** Display label */
+    label: string;
+    /** Display order */
+    order: number;
+    /** Whether this is a system section */
+    system: boolean;
+    /** Whether section is visible */
+    visible: boolean;
+    /** Whether section is collapsed by default */
+    collapse: boolean;
+    /** Whether section is editable */
+    editable: boolean;
+    /** Whether section is expandable */
+    expandable: boolean;
+}
+/**
+ * Payload for document type resource.
+ */
+export interface DocumentTypePayload {
+    /** Display name */
+    display: string;
+    /** Type identifier */
+    type: string;
+    /** Module */
+    module: string;
+    /** Submodule */
+    submodule: string;
+    /** Field definitions */
+    fields: DocumentTypeField[];
+    /** Section definitions */
+    sections: DocumentTypeSection[];
+}
+/**
+ * Full document type resource.
+ */
+export interface ZudelloDocumentType {
+    /** Resource version */
+    version: string;
+    /** Resource UUID */
+    uuid: string;
+    /** Team UUID */
+    team_uuid: string;
+    /** Context (module -> submodule[] mapping) */
+    context: Record<string, string[]> | null;
+    /** Document type payload */
+    payload: DocumentTypePayload;
+    /** Creation timestamp */
+    created_at: string;
+    /** Update timestamp */
+    updated_at: string;
+    /** Deletion timestamp */
+    deleted_at: string | null;
+    /** Whether this is a global resource */
+    global_resource: boolean;
+    /** Resource type */
+    resource_type: 'document_type';
+    /** Error message if any */
+    error: string | null;
+}
+/**
+ * Options for listing document types.
+ */
+export interface ListDocumentTypesOptions {
+    /** Filter by module */
+    module?: string;
+    /** Filter by submodule */
+    submodule?: string;
+    /** Paths to include */
+    includePaths?: string[];
+    /** Whether to include global resources (default: false) */
+    globalResource?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map