generaltranslation/dist/types-dir/api/uploadFiles.d.ts

A language toolkit for AI developers

import { DataFormat } from '../jsx/content';
import { FileFormat, FileReference } from './file';
/**
 * Metadata stored alongside GTJSON file entries.
 * Keys correspond to the entry id/hash in the GTJSON body.
 */
export type GTJsonFormatMetadata = Record<string, {
    context?: string;
    id?: string;
    domain?: string;
    maxChars?: number;
    dataFormat?: 'JSX' | 'ICU';
    requestVersion?: number;
    approved_at?: string | null;
    approved_by?: string | null;
    hash?: string;
    filePaths?: string[];
}>;
export type FileUpload = {
    branchId?: string;
    incomingBranchId?: string;
    checkedOutBranchId?: string;
    content: string;
    fileName: string;
    fileFormat: FileFormat;
    dataFormat?: DataFormat;
    locale: string;
    formatMetadata?: GTJsonFormatMetadata;
    versionId?: string;
    fileId?: string;
};
export type UploadFilesOptions = {
    sourceLocale: string;
    modelProvider?: string;
    timeout?: number;
};
export type UploadFilesResponse = {
    uploadedFiles: FileReference[];
    count: number;
    message: string;
};
export type RequiredUploadFilesOptions = UploadFilesOptions & Required<Pick<UploadFilesOptions, 'sourceLocale'>>;