@base44/sdk/dist/types.d.ts

JavaScript SDK for Base44 API

export * from "./modules/types.js";
/**
 * Parameters for filtering, sorting, and paginating agent model data.
 *
 * Used in the agents module for querying agent conversations. Provides a structured way to specify query criteria, sorting, pagination, and field selection.
 *
 * @property q - Query object with field-value pairs for filtering.
 * @property sort - Sort parameter. For example, "-created_date" for descending order.
 * @property sort_by - Alternative sort parameter. Use either `sort` or `sort_by`.
 * @property limit - Maximum number of results to return.
 * @property skip - Number of results to skip. Used for pagination.
 * @property fields - Array of field names to include in the response.
 *
 * @example
 * ```typescript
 * // Filter conversations by agent name
 * const conversations = await base44.agents.listConversations({
 *   q: { agent_name: 'support-bot' }
 * });
 * ```
 *
 * @example
 * ```typescript
 * // Filter conversations with sorting
 * const conversations = await base44.agents.listConversations({
 *   q: { status: 'active' },
 *   sort: '-created_at'  // Sort by created_at descending
 * });
 * ```
 *
 * @example
 * ```typescript
 * // Filter conversations with pagination
 * const conversations = await base44.agents.listConversations({
 *   q: { agent_name: 'support-bot' },
 *   limit: 20,  // Get 20 results
 *   skip: 40    // Skip first 40 (page 3)
 * });
 * ```
 *
 * @example
 * ```typescript
 * // Filter conversations with field selection
 * const conversations = await base44.agents.listConversations({
 *   q: { status: 'active' },
 *   fields: ['id', 'agent_name', 'created_at']
 * });
 * ```
 *
 * @example
 * ```typescript
 * // Filter conversations with multiple filters
 * const conversations = await base44.agents.listConversations({
 *   q: {
 *     agent_name: 'support-bot',
 *     'metadata.priority': 'high',
 *     status: 'active'
 *   },
 *   sort: '-updated_at',
 *   limit: 50,
 *   skip: 0
 * });
 * ```
 */
export interface ModelFilterParams {
    q?: Record<string, any>;
    sort?: string | null;
    sort_by?: string | null;
    limit?: number | null;
    skip?: number | null;
    fields?: string[] | null;
}