@crowdin/crowdin-api-client/out/dictionaries/index.d.ts

JavaScript library for Crowdin API

import { CrowdinApi, PatchRequest, ResponseList, ResponseObject } from '../core';
/**
 * Dictionaries allow you to create a storage of words that should be skipped by the spell checker.
 *
 * Use API to get the list of organization dictionaries and to edit a specific dictionary.
 */
export declare class Dictionaries extends CrowdinApi {
    /**
     * @param projectId project identifier
     * @param options optional parameters for listing dictionaries
     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany
     */
    listDictionaries(projectId: number, options?: DictionariesModel.ListDictionariesOptions): Promise<ResponseList<DictionariesModel.Dictionary>>;
    /**
     * @param projectId project identifier
     * @param languageIds filter progress by Language Identifiers
     * @deprecated optional parameters should be passed through an object
     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany
     */
    listDictionaries(projectId: number, languageIds?: string): Promise<ResponseList<DictionariesModel.Dictionary>>;
    /**
     * @param projectId project identifier
     * @param languageId language identifier
     * @param request request body
     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.patch
     */
    editDictionary(projectId: number, languageId: string, request: PatchRequest[]): Promise<ResponseObject<DictionariesModel.Dictionary>>;
}
export declare namespace DictionariesModel {
    interface Dictionary {
        languageId: string;
        words: string[];
    }
    interface ListDictionariesOptions {
        languageIds?: string;
    }
}