import { APIResource } from "../../core/resource.js"; import * as WordsAPI from "./words.js"; import { WordAddParams, WordAddResponse, WordRemoveParams, WordRemoveResponse, Words } from "./words.js"; import { APIPromise } from "../../core/api-promise.js"; import { RequestOptions } from "../../internal/request-options.js"; export declare class Wordlist extends APIResource { words: WordsAPI.Words; /** * Get a specific wordlist by ID */ retrieve(id: string, options?: RequestOptions): APIPromise; /** * Update a wordlist */ update(id: string, body: WordlistUpdateParams, options?: RequestOptions): APIPromise; /** * List all wordlists for the authenticated organization */ list(options?: RequestOptions): APIPromise; /** * Get the current embedding progress status for a wordlist */ getEmbeddingStatus(id: string, options?: RequestOptions): APIPromise; } export interface WordlistRetrieveResponse { /** * ID of the wordlist */ id: string; /** * Creation date of the wordlist */ createdAt: string; /** * Name of the wordlist */ name: string | null; /** * ID of the organization */ organizationId: string; /** * Strict mode */ strict: boolean; /** * ID of the user */ userId: string | null; /** * Words in the wordlist */ words: Array; } export interface WordlistUpdateResponse { /** * ID of the wordlist */ id: string; /** * Creation date of the wordlist */ createdAt: string; /** * Name of the wordlist */ name: string | null; /** * ID of the organization */ organizationId: string; /** * Strict mode */ strict: boolean; /** * ID of the user */ userId: string | null; /** * Words in the wordlist */ words: Array; } /** * Array of wordlists */ export type WordlistListResponse = Array; export declare namespace WordlistListResponse { interface WordlistListResponseItem { /** * Unique identifier of the wordlist */ id: string; /** * When the wordlist was created */ createdAt: string | null; /** * Description of the wordlist */ description: string | null; /** * Name of the wordlist */ name: string | null; /** * User who created the wordlist */ userId: string | null; } } /** * Embedding status details */ export interface WordlistGetEmbeddingStatusResponse { /** * Percentage of words that have been embedded (0-100) */ progress: number; /** * Number of words still waiting to be embedded */ remainingWords: number; /** * Total number of words in the wordlist */ totalWords: number; } export interface WordlistUpdateParams { /** * New description for the wordlist */ description?: string; /** * New key for the wordlist */ key?: string; /** * New name for the wordlist */ name?: string; /** * Deprecated. Now using threshold in project settings. */ strict?: boolean; /** * New words for the wordlist. Replace the existing words with these new ones. * Duplicate words will be ignored. */ words?: Array; } export declare namespace Wordlist { export { type WordlistRetrieveResponse as WordlistRetrieveResponse, type WordlistUpdateResponse as WordlistUpdateResponse, type WordlistListResponse as WordlistListResponse, type WordlistGetEmbeddingStatusResponse as WordlistGetEmbeddingStatusResponse, type WordlistUpdateParams as WordlistUpdateParams, }; export { Words as Words, type WordAddResponse as WordAddResponse, type WordRemoveResponse as WordRemoveResponse, type WordAddParams as WordAddParams, type WordRemoveParams as WordRemoveParams, }; } //# sourceMappingURL=wordlist.d.ts.map