import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface ContributorsListResponse */ export interface ContributorsListResponse { /** * * @type {ResponseResponse} * @memberof ContributorsListResponse */ response?: ResponseResponse; /** * * @type {ContributorsListResponseAllOfResult} * @memberof ContributorsListResponse */ result?: ContributorsListResponseAllOfResult; } /** * * @export * @interface ContributorsListResponseAllOfResult */ export interface ContributorsListResponseAllOfResult { /** * * @type {Array} * @memberof ContributorsListResponseAllOfResult */ contributors?: Array; } /** * * @export * @interface ContributorsListResponseAllOfResultContributors */ export interface ContributorsListResponseAllOfResultContributors { /** * * @type {string} * @memberof ContributorsListResponseAllOfResultContributors */ name?: string; /** * * @type {string} * @memberof ContributorsListResponseAllOfResultContributors */ email?: string; /** * * @type {Array} * @memberof ContributorsListResponseAllOfResultContributors */ permissions?: Array; } /** * * @export * @interface ContributorsListResponseAllOfResultPermissions */ export interface ContributorsListResponseAllOfResultPermissions { /** * * @type {ContributorsListResponseAllOfResultProject} * @memberof ContributorsListResponseAllOfResultPermissions */ project?: ContributorsListResponseAllOfResultProject; /** * * @type {string} * @memberof ContributorsListResponseAllOfResultPermissions */ type?: string; /** * * @type {boolean} * @memberof ContributorsListResponseAllOfResultPermissions */ proofreader?: boolean; } /** * * @export * @interface ContributorsListResponseAllOfResultProject */ export interface ContributorsListResponseAllOfResultProject { /** * * @type {string} * @memberof ContributorsListResponseAllOfResultProject */ id?: string; /** * * @type {string} * @memberof ContributorsListResponseAllOfResultProject */ name?: string; } /** * * @export * @interface LanguagesListLong */ export interface LanguagesListLong { /** * * @type {Array} * @memberof LanguagesListLong */ languages?: Array; } /** * * @export * @interface LanguagesListLongLanguagesInner */ export interface LanguagesListLongLanguagesInner { /** * * @type {string} * @memberof LanguagesListLongLanguagesInner */ name?: string; /** * * @type {string} * @memberof LanguagesListLongLanguagesInner */ code?: string; /** * * @type {number} * @memberof LanguagesListLongLanguagesInner */ translations?: number; /** * * @type {number} * @memberof LanguagesListLongLanguagesInner */ percentage?: number; /** * * @type {string} * @memberof LanguagesListLongLanguagesInner */ updated?: string; } /** * * @export * @interface LanguagesListLongResponse */ export interface LanguagesListLongResponse { /** * * @type {ResponseResponse} * @memberof LanguagesListLongResponse */ response?: ResponseResponse; /** * * @type {LanguagesListLong} * @memberof LanguagesListLongResponse */ result?: LanguagesListLong; } /** * * @export * @interface LanguagesListShort */ export interface LanguagesListShort { /** * * @type {Array} * @memberof LanguagesListShort */ languages?: Array; } /** * * @export * @interface LanguagesListShortLanguagesInner */ export interface LanguagesListShortLanguagesInner { /** * * @type {string} * @memberof LanguagesListShortLanguagesInner */ name?: string; /** * * @type {string} * @memberof LanguagesListShortLanguagesInner */ code?: string; } /** * * @export * @interface LanguagesListShortResponse */ export interface LanguagesListShortResponse { /** * * @type {ResponseResponse} * @memberof LanguagesListShortResponse */ response?: ResponseResponse; /** * * @type {LanguagesListShort} * @memberof LanguagesListShortResponse */ result?: LanguagesListShort; } /** * * @export * @interface ProjectExportResponse */ export interface ProjectExportResponse { /** * * @type {ResponseResponse} * @memberof ProjectExportResponse */ response?: ResponseResponse; /** * * @type {ProjectExportResponseAllOfResult} * @memberof ProjectExportResponse */ result?: ProjectExportResponseAllOfResult; } /** * * @export * @interface ProjectExportResponseAllOfResult */ export interface ProjectExportResponseAllOfResult { /** * * @type {string} * @memberof ProjectExportResponseAllOfResult */ url?: string; } /** * * @export * @interface ProjectList */ export interface ProjectList { /** * * @type {Array} * @memberof ProjectList */ projects?: Array; } /** * * @export * @interface ProjectListProjectsInner */ export interface ProjectListProjectsInner { /** * * @type {number} * @memberof ProjectListProjectsInner */ id?: number; /** * * @type {string} * @memberof ProjectListProjectsInner */ name?: string; /** * * @type {number} * @memberof ProjectListProjectsInner */ public?: ProjectListProjectsInnerPublicEnum; /** * * @type {number} * @memberof ProjectListProjectsInner */ open?: ProjectListProjectsInnerOpenEnum; /** * * @type {string} * @memberof ProjectListProjectsInner */ created?: string; } export declare const ProjectListProjectsInnerPublicEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectListProjectsInnerPublicEnum = (typeof ProjectListProjectsInnerPublicEnum)[keyof typeof ProjectListProjectsInnerPublicEnum]; export declare const ProjectListProjectsInnerOpenEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectListProjectsInnerOpenEnum = (typeof ProjectListProjectsInnerOpenEnum)[keyof typeof ProjectListProjectsInnerOpenEnum]; /** * * @export * @interface ProjectListResponse */ export interface ProjectListResponse { /** * * @type {ResponseResponse} * @memberof ProjectListResponse */ response?: ResponseResponse; /** * * @type {ProjectList} * @memberof ProjectListResponse */ result?: ProjectList; } /** * * @export * @interface ProjectLong */ export interface ProjectLong { /** * * @type {ProjectLongProject} * @memberof ProjectLong */ project?: ProjectLongProject; } /** * * @export * @interface ProjectLongProject */ export interface ProjectLongProject { /** * * @type {number} * @memberof ProjectLongProject */ id?: number; /** * * @type {string} * @memberof ProjectLongProject */ name?: string; /** * * @type {string} * @memberof ProjectLongProject */ description?: string; /** * * @type {number} * @memberof ProjectLongProject */ public?: ProjectLongProjectPublicEnum; /** * * @type {number} * @memberof ProjectLongProject */ open?: ProjectLongProjectOpenEnum; /** * * @type {string} * @memberof ProjectLongProject */ reference_language?: string; /** * * @type {string} * @memberof ProjectLongProject */ fallback_language?: string; /** * * @type {number} * @memberof ProjectLongProject */ terms?: number; /** * * @type {string} * @memberof ProjectLongProject */ created?: string; } export declare const ProjectLongProjectPublicEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectLongProjectPublicEnum = (typeof ProjectLongProjectPublicEnum)[keyof typeof ProjectLongProjectPublicEnum]; export declare const ProjectLongProjectOpenEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectLongProjectOpenEnum = (typeof ProjectLongProjectOpenEnum)[keyof typeof ProjectLongProjectOpenEnum]; /** * * @export * @interface ProjectSyncResponse */ export interface ProjectSyncResponse { /** * * @type {ResponseResponse} * @memberof ProjectSyncResponse */ response?: ResponseResponse; /** * * @type {TermsFull} * @memberof ProjectSyncResponse */ result?: TermsFull; } /** * * @export * @interface ProjectUploadResponse */ export interface ProjectUploadResponse { /** * * @type {ResponseResponse} * @memberof ProjectUploadResponse */ response?: ResponseResponse; /** * * @type {TermsTranslationsResponse} * @memberof ProjectUploadResponse */ result?: TermsTranslationsResponse; } /** * * @export * @interface ProjectViewResponse */ export interface ProjectViewResponse { /** * * @type {ResponseResponse} * @memberof ProjectViewResponse */ response?: ResponseResponse; /** * * @type {ProjectLong} * @memberof ProjectViewResponse */ result?: ProjectLong; } /** * * @export * @interface Response */ export interface Response { /** * * @type {ResponseResponse} * @memberof Response */ response?: ResponseResponse; } /** * * @export * @interface ResponseResponse */ export interface ResponseResponse { /** * * @type {string} * @memberof ResponseResponse */ status?: string; /** * * @type {string} * @memberof ResponseResponse */ code?: string; /** * * @type {string} * @memberof ResponseResponse */ message?: string; } /** * * @export * @interface TermAddCommentResponse */ export interface TermAddCommentResponse { /** * * @type {ResponseResponse} * @memberof TermAddCommentResponse */ response?: ResponseResponse; /** * * @type {TermsShortComment} * @memberof TermAddCommentResponse */ result?: TermsShortComment; } /** * * @export * @interface TermAddedResponse */ export interface TermAddedResponse { /** * * @type {ResponseResponse} * @memberof TermAddedResponse */ response?: ResponseResponse; /** * * @type {TermsShortAdded} * @memberof TermAddedResponse */ result?: TermsShortAdded; } /** * * @export * @interface TermDeletedResponse */ export interface TermDeletedResponse { /** * * @type {ResponseResponse} * @memberof TermDeletedResponse */ response?: ResponseResponse; /** * * @type {TermsShortDeleted} * @memberof TermDeletedResponse */ result?: TermsShortDeleted; } /** * * @export * @interface TermUpdatedResponse */ export interface TermUpdatedResponse { /** * * @type {ResponseResponse} * @memberof TermUpdatedResponse */ response?: ResponseResponse; /** * * @type {TermsShortUpdated} * @memberof TermUpdatedResponse */ result?: TermsShortUpdated; } /** * * @export * @interface TermsFull */ export interface TermsFull { /** * * @type {TermsFullTerms} * @memberof TermsFull */ terms?: TermsFullTerms; } /** * * @export * @interface TermsFullTerms */ export interface TermsFullTerms { /** * * @type {number} * @memberof TermsFullTerms */ parsed?: number; /** * * @type {number} * @memberof TermsFullTerms */ added?: number; /** * * @type {number} * @memberof TermsFullTerms */ updated?: number; /** * * @type {number} * @memberof TermsFullTerms */ deleted?: number; } /** * * @export * @interface TermsListFull */ export interface TermsListFull { /** * * @type {Array} * @memberof TermsListFull */ terms?: Array; } /** * * @export * @interface TermsListFullResponse */ export interface TermsListFullResponse { /** * * @type {ResponseResponse} * @memberof TermsListFullResponse */ response?: ResponseResponse; /** * * @type {TermsListFull} * @memberof TermsListFullResponse */ result?: TermsListFull; } /** * * @export * @interface TermsListFullTermsInner */ export interface TermsListFullTermsInner { /** * * @type {string} * @memberof TermsListFullTermsInner */ term?: string; /** * * @type {string} * @memberof TermsListFullTermsInner */ context?: string; /** * * @type {string} * @memberof TermsListFullTermsInner */ plural?: string; /** * * @type {string} * @memberof TermsListFullTermsInner */ created?: string; /** * * @type {string} * @memberof TermsListFullTermsInner */ updated?: string; /** * * @type {TermsListFullTermsInnerTranslation} * @memberof TermsListFullTermsInner */ translation?: TermsListFullTermsInnerTranslation; /** * * @type {string} * @memberof TermsListFullTermsInner */ reference?: string; /** * * @type {Array} * @memberof TermsListFullTermsInner */ tags?: Array; /** * * @type {string} * @memberof TermsListFullTermsInner */ comment?: string; } /** * * @export * @interface TermsListFullTermsInnerTranslation */ export interface TermsListFullTermsInnerTranslation { /** * * @type {string} * @memberof TermsListFullTermsInnerTranslation */ content?: string; /** * * @type {number} * @memberof TermsListFullTermsInnerTranslation */ fuzzy?: number; /** * * @type {number} * @memberof TermsListFullTermsInnerTranslation */ proofread?: number; /** * * @type {string} * @memberof TermsListFullTermsInnerTranslation */ updated?: string; } /** * * @export * @interface TermsLong */ export interface TermsLong { /** * * @type {TermsLongTerms} * @memberof TermsLong */ terms?: TermsLongTerms; } /** * * @export * @interface TermsLongTerms */ export interface TermsLongTerms { /** * * @type {number} * @memberof TermsLongTerms */ parsed?: number; /** * * @type {number} * @memberof TermsLongTerms */ added?: number; /** * * @type {number} * @memberof TermsLongTerms */ deleted?: number; } /** * * @export * @interface TermsShortAdded */ export interface TermsShortAdded { /** * * @type {TermsShortAddedTerms} * @memberof TermsShortAdded */ terms?: TermsShortAddedTerms; } /** * * @export * @interface TermsShortAddedTerms */ export interface TermsShortAddedTerms { /** * * @type {number} * @memberof TermsShortAddedTerms */ parsed?: number; /** * * @type {number} * @memberof TermsShortAddedTerms */ added?: number; } /** * * @export * @interface TermsShortComment */ export interface TermsShortComment { /** * * @type {TermsShortCommentTerms} * @memberof TermsShortComment */ terms?: TermsShortCommentTerms; } /** * * @export * @interface TermsShortCommentTerms */ export interface TermsShortCommentTerms { /** * * @type {number} * @memberof TermsShortCommentTerms */ parsed?: number; /** * * @type {number} * @memberof TermsShortCommentTerms */ with_added_comment?: number; } /** * * @export * @interface TermsShortDeleted */ export interface TermsShortDeleted { /** * * @type {TermsShortDeletedTerms} * @memberof TermsShortDeleted */ terms?: TermsShortDeletedTerms; } /** * * @export * @interface TermsShortDeletedTerms */ export interface TermsShortDeletedTerms { /** * * @type {number} * @memberof TermsShortDeletedTerms */ parsed?: number; /** * * @type {number} * @memberof TermsShortDeletedTerms */ deleted?: number; } /** * * @export * @interface TermsShortUpdated */ export interface TermsShortUpdated { /** * * @type {TermsShortUpdatedTerms} * @memberof TermsShortUpdated */ terms?: TermsShortUpdatedTerms; } /** * * @export * @interface TermsShortUpdatedTerms */ export interface TermsShortUpdatedTerms { /** * * @type {number} * @memberof TermsShortUpdatedTerms */ parsed?: number; /** * * @type {number} * @memberof TermsShortUpdatedTerms */ updated?: number; } /** * * @export * @interface TermsTranslationsResponse */ export interface TermsTranslationsResponse { /** * * @type {TermsLongTerms} * @memberof TermsTranslationsResponse */ terms?: TermsLongTerms; /** * * @type {TermsLongTerms} * @memberof TermsTranslationsResponse */ translations?: TermsLongTerms; } /** * * @export * @interface TranslationAddedResponse */ export interface TranslationAddedResponse { /** * * @type {ResponseResponse} * @memberof TranslationAddedResponse */ response?: ResponseResponse; /** * * @type {TranslationsShortAdded} * @memberof TranslationAddedResponse */ result?: TranslationsShortAdded; } /** * * @export * @interface TranslationAutomatedResponse */ export interface TranslationAutomatedResponse { /** * * @type {ResponseResponse} * @memberof TranslationAutomatedResponse */ response?: ResponseResponse; /** * * @type {TranslationsShortAutomated} * @memberof TranslationAutomatedResponse */ result?: TranslationsShortAutomated; } /** * * @export * @interface TranslationDeletedResponse */ export interface TranslationDeletedResponse { /** * * @type {ResponseResponse} * @memberof TranslationDeletedResponse */ response?: ResponseResponse; /** * * @type {TranslationsShortDeleted} * @memberof TranslationDeletedResponse */ result?: TranslationsShortDeleted; } /** * * @export * @interface TranslationUpdatedResponse */ export interface TranslationUpdatedResponse { /** * * @type {ResponseResponse} * @memberof TranslationUpdatedResponse */ response?: ResponseResponse; /** * * @type {TranslationsShortUpdated} * @memberof TranslationUpdatedResponse */ result?: TranslationsShortUpdated; } /** * * @export * @interface TranslationsLong */ export interface TranslationsLong { /** * * @type {TermsLongTerms} * @memberof TranslationsLong */ translations?: TermsLongTerms; } /** * * @export * @interface TranslationsShort */ export interface TranslationsShort { /** * * @type {TranslationsShortTranslations} * @memberof TranslationsShort */ translations?: TranslationsShortTranslations; } /** * * @export * @interface TranslationsShortAdded */ export interface TranslationsShortAdded { /** * * @type {TermsShortAddedTerms} * @memberof TranslationsShortAdded */ translations?: TermsShortAddedTerms; } /** * * @export * @interface TranslationsShortAutomated */ export interface TranslationsShortAutomated { /** * * @type {Array} * @memberof TranslationsShortAutomated */ successful?: Array; /** * * @type {Array} * @memberof TranslationsShortAutomated */ failed?: Array; } /** * * @export * @interface TranslationsShortAutomatedFailedInner */ export interface TranslationsShortAutomatedFailedInner { /** * * @type {string} * @memberof TranslationsShortAutomatedFailedInner */ source?: string; /** * * @type {string} * @memberof TranslationsShortAutomatedFailedInner */ target?: string; /** * * @type {string} * @memberof TranslationsShortAutomatedFailedInner */ message?: string; } /** * * @export * @interface TranslationsShortAutomatedSuccessfulInner */ export interface TranslationsShortAutomatedSuccessfulInner { /** * * @type {string} * @memberof TranslationsShortAutomatedSuccessfulInner */ source?: string; /** * * @type {string} * @memberof TranslationsShortAutomatedSuccessfulInner */ target?: string; /** * * @type {number} * @memberof TranslationsShortAutomatedSuccessfulInner */ chars?: number; } /** * * @export * @interface TranslationsShortDeleted */ export interface TranslationsShortDeleted { /** * * @type {TermsShortDeletedTerms} * @memberof TranslationsShortDeleted */ translations?: TermsShortDeletedTerms; } /** * * @export * @interface TranslationsShortResponse */ export interface TranslationsShortResponse { /** * * @type {ResponseResponse} * @memberof TranslationsShortResponse */ response?: ResponseResponse; /** * * @type {TranslationsShort} * @memberof TranslationsShortResponse */ result?: TranslationsShort; } /** * * @export * @interface TranslationsShortTranslations */ export interface TranslationsShortTranslations { /** * * @type {number} * @memberof TranslationsShortTranslations */ parsed?: number; /** * * @type {number} * @memberof TranslationsShortTranslations */ added?: number; /** * * @type {number} * @memberof TranslationsShortTranslations */ updated?: number; } /** * * @export * @interface TranslationsShortUpdated */ export interface TranslationsShortUpdated { /** * * @type {TermsShortUpdatedTerms} * @memberof TranslationsShortUpdated */ translations?: TermsShortUpdatedTerms; } /** * ContributorsApi - axios parameter creator * @export */ export declare const ContributorsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_add). * @summary Adds a contributor to a project language or an administrator to a project. * @param {string} id The id of project * @param {string} name The name of contributor * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if adding a contributor) * @param {ContributorsAddAdminEnum} [admin] Set it to 1 for adding as administrator * @param {*} [options] Override http request option. * @throws {RequiredError} */ contributorsAdd: (id: string, name: string, email: string, apiToken?: string, language?: string, admin?: ContributorsAddAdminEnum, options?: RawAxiosRequestConfig) => Promise; /** * Remove Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_remove). * @summary Removes a contributor from a project language or an admin from a project, if the language is not specified. * @param {string} id The id of project * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if removing a contributor from a certain language) * @param {*} [options] Override http request option. * @throws {RequiredError} */ contributorsRemove: (id: string, email: string, apiToken?: string, language?: string, options?: RawAxiosRequestConfig) => Promise; /** * List Contributors. More details in the [documentation](https://poeditor.com/docs/api#contributors_list). * @summary Returns the list of contributors from your projects. * @param {string} [apiToken] * @param {string} [id] The id of project (Optional, unless language is set. Then, it becomes required) * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsList: (apiToken?: string, id?: string, language?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ContributorsApi - functional programming interface * @export */ export declare const ContributorsApiFp: (configuration?: Configuration) => { /** * Add Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_add). * @summary Adds a contributor to a project language or an administrator to a project. * @param {string} id The id of project * @param {string} name The name of contributor * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if adding a contributor) * @param {ContributorsAddAdminEnum} [admin] Set it to 1 for adding as administrator * @param {*} [options] Override http request option. * @throws {RequiredError} */ contributorsAdd(id: string, name: string, email: string, apiToken?: string, language?: string, admin?: ContributorsAddAdminEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_remove). * @summary Removes a contributor from a project language or an admin from a project, if the language is not specified. * @param {string} id The id of project * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if removing a contributor from a certain language) * @param {*} [options] Override http request option. * @throws {RequiredError} */ contributorsRemove(id: string, email: string, apiToken?: string, language?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Contributors. More details in the [documentation](https://poeditor.com/docs/api#contributors_list). * @summary Returns the list of contributors from your projects. * @param {string} [apiToken] * @param {string} [id] The id of project (Optional, unless language is set. Then, it becomes required) * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsList(apiToken?: string, id?: string, language?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContributorsApi - factory interface * @export */ export declare const ContributorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_add). * @summary Adds a contributor to a project language or an administrator to a project. * @param {string} id The id of project * @param {string} name The name of contributor * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if adding a contributor) * @param {ContributorsAddAdminEnum} [admin] Set it to 1 for adding as administrator * @param {*} [options] Override http request option. * @throws {RequiredError} */ contributorsAdd(id: string, name: string, email: string, apiToken?: string, language?: string, admin?: ContributorsAddAdminEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Remove Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_remove). * @summary Removes a contributor from a project language or an admin from a project, if the language is not specified. * @param {string} id The id of project * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if removing a contributor from a certain language) * @param {*} [options] Override http request option. * @throws {RequiredError} */ contributorsRemove(id: string, email: string, apiToken?: string, language?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * List Contributors. More details in the [documentation](https://poeditor.com/docs/api#contributors_list). * @summary Returns the list of contributors from your projects. * @param {string} [apiToken] * @param {string} [id] The id of project (Optional, unless language is set. Then, it becomes required) * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsList(apiToken?: string, id?: string, language?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ContributorsApi - object-oriented interface * @export * @class ContributorsApi * @extends {BaseAPI} */ export declare class ContributorsApi extends BaseAPI { /** * Add Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_add). * @summary Adds a contributor to a project language or an administrator to a project. * @param {string} id The id of project * @param {string} name The name of contributor * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if adding a contributor) * @param {ContributorsAddAdminEnum} [admin] Set it to 1 for adding as administrator * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContributorsApi */ contributorsAdd(id: string, name: string, email: string, apiToken?: string, language?: string, admin?: ContributorsAddAdminEnum, options?: RawAxiosRequestConfig): Promise>; /** * Remove Contributor. More details in the [documentation](https://poeditor.com/docs/api#contributors_remove). * @summary Removes a contributor from a project language or an admin from a project, if the language is not specified. * @param {string} id The id of project * @param {string} email The email of contributor * @param {string} [apiToken] * @param {string} [language] The language code (Required if removing a contributor from a certain language) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContributorsApi */ contributorsRemove(id: string, email: string, apiToken?: string, language?: string, options?: RawAxiosRequestConfig): Promise>; /** * List Contributors. More details in the [documentation](https://poeditor.com/docs/api#contributors_list). * @summary Returns the list of contributors from your projects. * @param {string} [apiToken] * @param {string} [id] The id of project (Optional, unless language is set. Then, it becomes required) * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContributorsApi */ translationsList(apiToken?: string, id?: string, language?: string, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ContributorsAddAdminEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ContributorsAddAdminEnum = (typeof ContributorsAddAdminEnum)[keyof typeof ContributorsAddAdminEnum]; /** * LanguagesApi - axios parameter creator * @export */ export declare const LanguagesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add Language to Project. More details in the [documentation](https://poeditor.com/docs/api#languages_add). * @summary Adds a new language to project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesAdd: (id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Delete Language from Project. More details in the [documentation](https://poeditor.com/docs/api#languages_delete). * @summary Deletes existing language from project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesDelete: (id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_list). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesList: (id: number, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update Project Language. More details in the [documentation](https://poeditor.com/docs/api#languages_update). * @summary Inserts / overwrites translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {LanguagesUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesUpdate: (id: number, language: string, data: string, apiToken?: string, fuzzyTrigger?: LanguagesUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig) => Promise; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_available). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsAvailable: (id: number, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * LanguagesApi - functional programming interface * @export */ export declare const LanguagesApiFp: (configuration?: Configuration) => { /** * Add Language to Project. More details in the [documentation](https://poeditor.com/docs/api#languages_add). * @summary Adds a new language to project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesAdd(id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete Language from Project. More details in the [documentation](https://poeditor.com/docs/api#languages_delete). * @summary Deletes existing language from project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesDelete(id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_list). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesList(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update Project Language. More details in the [documentation](https://poeditor.com/docs/api#languages_update). * @summary Inserts / overwrites translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {LanguagesUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesUpdate(id: number, language: string, data: string, apiToken?: string, fuzzyTrigger?: LanguagesUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_available). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsAvailable(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LanguagesApi - factory interface * @export */ export declare const LanguagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add Language to Project. More details in the [documentation](https://poeditor.com/docs/api#languages_add). * @summary Adds a new language to project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesAdd(id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete Language from Project. More details in the [documentation](https://poeditor.com/docs/api#languages_delete). * @summary Deletes existing language from project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesDelete(id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_list). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesList(id: number, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update Project Language. More details in the [documentation](https://poeditor.com/docs/api#languages_update). * @summary Inserts / overwrites translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {LanguagesUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ languagesUpdate(id: number, language: string, data: string, apiToken?: string, fuzzyTrigger?: LanguagesUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_available). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsAvailable(id: number, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * LanguagesApi - object-oriented interface * @export * @class LanguagesApi * @extends {BaseAPI} */ export declare class LanguagesApi extends BaseAPI { /** * Add Language to Project. More details in the [documentation](https://poeditor.com/docs/api#languages_add). * @summary Adds a new language to project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LanguagesApi */ languagesAdd(id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Delete Language from Project. More details in the [documentation](https://poeditor.com/docs/api#languages_delete). * @summary Deletes existing language from project. * @param {number} id * @param {string} language * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LanguagesApi */ languagesDelete(id: number, language: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_list). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LanguagesApi */ languagesList(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update Project Language. More details in the [documentation](https://poeditor.com/docs/api#languages_update). * @summary Inserts / overwrites translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {LanguagesUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LanguagesApi */ languagesUpdate(id: number, language: string, data: string, apiToken?: string, fuzzyTrigger?: LanguagesUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig): Promise>; /** * List Languages. More details in the [documentation](https://poeditor.com/docs/api#languages_available). * @summary Returns project languages, percentage of translation done for each and the datetime (UTC - ISO 8601) when the last change was made. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LanguagesApi */ projectsAvailable(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const LanguagesUpdateFuzzyTriggerEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type LanguagesUpdateFuzzyTriggerEnum = (typeof LanguagesUpdateFuzzyTriggerEnum)[keyof typeof LanguagesUpdateFuzzyTriggerEnum]; /** * ProjectsApi - axios parameter creator * @export */ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add Project. More details in the [documentation](https://poeditor.com/docs/api#projects_add). * @summary Creates a new project. Returns project details (if successful). * @param {string} name * @param {string} [apiToken] * @param {string} [description] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsAdd: (name: string, apiToken?: string, description?: string, options?: RawAxiosRequestConfig) => Promise; /** * Delete Project. More details in the [documentation](https://poeditor.com/docs/api#projects_delete). * @summary Deletes the project from the account. You must be the owner of the project. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsDelete: (id: number, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Export. More details in the [documentation](https://poeditor.com/docs/api#projects_export). * @summary Returns the link of the file (expires after 10 minutes). The settings inherited from the project will be the ones at the time of the download. * @param {number} id * @param {string} language * @param {ProjectsExportTypeEnum} type * @param {string} [apiToken] * @param {string} [filters] * @param {string} [order] * @param {string} [tags] * @param {ProjectsExportOptionsEnum} [_options] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsExport: (id: number, language: string, type: ProjectsExportTypeEnum, apiToken?: string, filters?: string, order?: string, tags?: string, _options?: ProjectsExportOptionsEnum, options?: RawAxiosRequestConfig) => Promise; /** * List Projects. More details in the [documentation](https://poeditor.com/docs/api#projects_list). * @summary Returns the list of projects owned by user. * @param {string} apiToken * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsList: (apiToken: string, options?: RawAxiosRequestConfig) => Promise; /** * Sync Terms. More details in the [documentation](https://poeditor.com/docs/api#projects_sync). * @summary Syncs your project with the array you send (terms that are not found in the JSON object will be deleted from project and the new ones added). Please use with caution. If wrong data is sent, existing terms and their translations might be irreversibly lost. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsSync: (id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update Project Settings. More details in the [documentation](https://poeditor.com/docs/api#projects_update). * @summary Updates project settings (name, description, reference language, fallback language). If optional parameters are not sent, their respective fields are not updated. * @param {number} id * @param {string} [apiToken] * @param {string} [name] * @param {string} [description] * @param {string} [referenceLanguage] * @param {string} [fallbackLanguage] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsUpdate: (id: number, apiToken?: string, name?: string, description?: string, referenceLanguage?: string, fallbackLanguage?: string, options?: RawAxiosRequestConfig) => Promise; /** * Upload. More details in the [documentation](https://poeditor.com/docs/api#projects_upload). * @summary Updates terms / translations - No more than one request every 20 seconds. * @param {ProjectsUploadUpdatingEnum} updating * @param {File} file Uploaded file (.po, .xls or any of the supported file formats) * @param {string} [apiToken] * @param {number} [id] * @param {string} [language] The language code (Required only if `updating` is terms_translations or translations). When using `terms_translations` with `.xcstrings` file format, leave it empty to import all the languages in the file. * @param {ProjectsUploadOverwriteEnum} [overwrite] Set it to 1 if you want to overwrite translations * @param {ProjectsUploadSyncTermsEnum} [syncTerms] Set it to 1 if you want to sync your terms (terms that are not found in the uploaded file will be deleted from project and the new ones added). Ignored if `updating` = translations. * @param {string} [tags] Add tags to the project terms; available when updating terms or terms_translations; you can use the following keys: \\\"all\\\" - for the all the imported terms, \\\"new\\\" - for the terms which arent already in the project, \\\"obsolete\\\" - for the terms which are in the project but not in the imported file and \\\"overwritten_translations\\\" - for the terms for which translations change * @param {ProjectsUploadReadFromSourceEnum} [readFromSource] For .xliff format only - set it to 1 if you want to import translations from the source tag * @param {ProjectsUploadFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsUpload: (updating: ProjectsUploadUpdatingEnum, file: File, apiToken?: string, id?: number, language?: string, overwrite?: ProjectsUploadOverwriteEnum, syncTerms?: ProjectsUploadSyncTermsEnum, tags?: string, readFromSource?: ProjectsUploadReadFromSourceEnum, fuzzyTrigger?: ProjectsUploadFuzzyTriggerEnum, options?: RawAxiosRequestConfig) => Promise; /** * View Project Details. More details in the [documentation](https://poeditor.com/docs/api#projects_view). * @summary Returns projects details * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsView: (id: number, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ProjectsApi - functional programming interface * @export */ export declare const ProjectsApiFp: (configuration?: Configuration) => { /** * Add Project. More details in the [documentation](https://poeditor.com/docs/api#projects_add). * @summary Creates a new project. Returns project details (if successful). * @param {string} name * @param {string} [apiToken] * @param {string} [description] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsAdd(name: string, apiToken?: string, description?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete Project. More details in the [documentation](https://poeditor.com/docs/api#projects_delete). * @summary Deletes the project from the account. You must be the owner of the project. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsDelete(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Export. More details in the [documentation](https://poeditor.com/docs/api#projects_export). * @summary Returns the link of the file (expires after 10 minutes). The settings inherited from the project will be the ones at the time of the download. * @param {number} id * @param {string} language * @param {ProjectsExportTypeEnum} type * @param {string} [apiToken] * @param {string} [filters] * @param {string} [order] * @param {string} [tags] * @param {ProjectsExportOptionsEnum} [_options] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsExport(id: number, language: string, type: ProjectsExportTypeEnum, apiToken?: string, filters?: string, order?: string, tags?: string, _options?: ProjectsExportOptionsEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Projects. More details in the [documentation](https://poeditor.com/docs/api#projects_list). * @summary Returns the list of projects owned by user. * @param {string} apiToken * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsList(apiToken: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sync Terms. More details in the [documentation](https://poeditor.com/docs/api#projects_sync). * @summary Syncs your project with the array you send (terms that are not found in the JSON object will be deleted from project and the new ones added). Please use with caution. If wrong data is sent, existing terms and their translations might be irreversibly lost. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsSync(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update Project Settings. More details in the [documentation](https://poeditor.com/docs/api#projects_update). * @summary Updates project settings (name, description, reference language, fallback language). If optional parameters are not sent, their respective fields are not updated. * @param {number} id * @param {string} [apiToken] * @param {string} [name] * @param {string} [description] * @param {string} [referenceLanguage] * @param {string} [fallbackLanguage] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsUpdate(id: number, apiToken?: string, name?: string, description?: string, referenceLanguage?: string, fallbackLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Upload. More details in the [documentation](https://poeditor.com/docs/api#projects_upload). * @summary Updates terms / translations - No more than one request every 20 seconds. * @param {ProjectsUploadUpdatingEnum} updating * @param {File} file Uploaded file (.po, .xls or any of the supported file formats) * @param {string} [apiToken] * @param {number} [id] * @param {string} [language] The language code (Required only if `updating` is terms_translations or translations). When using `terms_translations` with `.xcstrings` file format, leave it empty to import all the languages in the file. * @param {ProjectsUploadOverwriteEnum} [overwrite] Set it to 1 if you want to overwrite translations * @param {ProjectsUploadSyncTermsEnum} [syncTerms] Set it to 1 if you want to sync your terms (terms that are not found in the uploaded file will be deleted from project and the new ones added). Ignored if `updating` = translations. * @param {string} [tags] Add tags to the project terms; available when updating terms or terms_translations; you can use the following keys: \\\"all\\\" - for the all the imported terms, \\\"new\\\" - for the terms which arent already in the project, \\\"obsolete\\\" - for the terms which are in the project but not in the imported file and \\\"overwritten_translations\\\" - for the terms for which translations change * @param {ProjectsUploadReadFromSourceEnum} [readFromSource] For .xliff format only - set it to 1 if you want to import translations from the source tag * @param {ProjectsUploadFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsUpload(updating: ProjectsUploadUpdatingEnum, file: File, apiToken?: string, id?: number, language?: string, overwrite?: ProjectsUploadOverwriteEnum, syncTerms?: ProjectsUploadSyncTermsEnum, tags?: string, readFromSource?: ProjectsUploadReadFromSourceEnum, fuzzyTrigger?: ProjectsUploadFuzzyTriggerEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View Project Details. More details in the [documentation](https://poeditor.com/docs/api#projects_view). * @summary Returns projects details * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsView(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProjectsApi - factory interface * @export */ export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add Project. More details in the [documentation](https://poeditor.com/docs/api#projects_add). * @summary Creates a new project. Returns project details (if successful). * @param {string} name * @param {string} [apiToken] * @param {string} [description] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsAdd(name: string, apiToken?: string, description?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete Project. More details in the [documentation](https://poeditor.com/docs/api#projects_delete). * @summary Deletes the project from the account. You must be the owner of the project. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsDelete(id: number, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Export. More details in the [documentation](https://poeditor.com/docs/api#projects_export). * @summary Returns the link of the file (expires after 10 minutes). The settings inherited from the project will be the ones at the time of the download. * @param {number} id * @param {string} language * @param {ProjectsExportTypeEnum} type * @param {string} [apiToken] * @param {string} [filters] * @param {string} [order] * @param {string} [tags] * @param {ProjectsExportOptionsEnum} [_options] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsExport(id: number, language: string, type: ProjectsExportTypeEnum, apiToken?: string, filters?: string, order?: string, tags?: string, _options?: ProjectsExportOptionsEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * List Projects. More details in the [documentation](https://poeditor.com/docs/api#projects_list). * @summary Returns the list of projects owned by user. * @param {string} apiToken * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsList(apiToken: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sync Terms. More details in the [documentation](https://poeditor.com/docs/api#projects_sync). * @summary Syncs your project with the array you send (terms that are not found in the JSON object will be deleted from project and the new ones added). Please use with caution. If wrong data is sent, existing terms and their translations might be irreversibly lost. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsSync(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update Project Settings. More details in the [documentation](https://poeditor.com/docs/api#projects_update). * @summary Updates project settings (name, description, reference language, fallback language). If optional parameters are not sent, their respective fields are not updated. * @param {number} id * @param {string} [apiToken] * @param {string} [name] * @param {string} [description] * @param {string} [referenceLanguage] * @param {string} [fallbackLanguage] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsUpdate(id: number, apiToken?: string, name?: string, description?: string, referenceLanguage?: string, fallbackLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Upload. More details in the [documentation](https://poeditor.com/docs/api#projects_upload). * @summary Updates terms / translations - No more than one request every 20 seconds. * @param {ProjectsUploadUpdatingEnum} updating * @param {File} file Uploaded file (.po, .xls or any of the supported file formats) * @param {string} [apiToken] * @param {number} [id] * @param {string} [language] The language code (Required only if `updating` is terms_translations or translations). When using `terms_translations` with `.xcstrings` file format, leave it empty to import all the languages in the file. * @param {ProjectsUploadOverwriteEnum} [overwrite] Set it to 1 if you want to overwrite translations * @param {ProjectsUploadSyncTermsEnum} [syncTerms] Set it to 1 if you want to sync your terms (terms that are not found in the uploaded file will be deleted from project and the new ones added). Ignored if `updating` = translations. * @param {string} [tags] Add tags to the project terms; available when updating terms or terms_translations; you can use the following keys: \\\"all\\\" - for the all the imported terms, \\\"new\\\" - for the terms which arent already in the project, \\\"obsolete\\\" - for the terms which are in the project but not in the imported file and \\\"overwritten_translations\\\" - for the terms for which translations change * @param {ProjectsUploadReadFromSourceEnum} [readFromSource] For .xliff format only - set it to 1 if you want to import translations from the source tag * @param {ProjectsUploadFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsUpload(updating: ProjectsUploadUpdatingEnum, file: File, apiToken?: string, id?: number, language?: string, overwrite?: ProjectsUploadOverwriteEnum, syncTerms?: ProjectsUploadSyncTermsEnum, tags?: string, readFromSource?: ProjectsUploadReadFromSourceEnum, fuzzyTrigger?: ProjectsUploadFuzzyTriggerEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * View Project Details. More details in the [documentation](https://poeditor.com/docs/api#projects_view). * @summary Returns projects details * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ projectsView(id: number, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ProjectsApi - object-oriented interface * @export * @class ProjectsApi * @extends {BaseAPI} */ export declare class ProjectsApi extends BaseAPI { /** * Add Project. More details in the [documentation](https://poeditor.com/docs/api#projects_add). * @summary Creates a new project. Returns project details (if successful). * @param {string} name * @param {string} [apiToken] * @param {string} [description] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsAdd(name: string, apiToken?: string, description?: string, options?: RawAxiosRequestConfig): Promise>; /** * Delete Project. More details in the [documentation](https://poeditor.com/docs/api#projects_delete). * @summary Deletes the project from the account. You must be the owner of the project. * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsDelete(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Export. More details in the [documentation](https://poeditor.com/docs/api#projects_export). * @summary Returns the link of the file (expires after 10 minutes). The settings inherited from the project will be the ones at the time of the download. * @param {number} id * @param {string} language * @param {ProjectsExportTypeEnum} type * @param {string} [apiToken] * @param {string} [filters] * @param {string} [order] * @param {string} [tags] * @param {ProjectsExportOptionsEnum} [_options] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsExport(id: number, language: string, type: ProjectsExportTypeEnum, apiToken?: string, filters?: string, order?: string, tags?: string, _options?: ProjectsExportOptionsEnum, options?: RawAxiosRequestConfig): Promise>; /** * List Projects. More details in the [documentation](https://poeditor.com/docs/api#projects_list). * @summary Returns the list of projects owned by user. * @param {string} apiToken * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsList(apiToken: string, options?: RawAxiosRequestConfig): Promise>; /** * Sync Terms. More details in the [documentation](https://poeditor.com/docs/api#projects_sync). * @summary Syncs your project with the array you send (terms that are not found in the JSON object will be deleted from project and the new ones added). Please use with caution. If wrong data is sent, existing terms and their translations might be irreversibly lost. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsSync(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update Project Settings. More details in the [documentation](https://poeditor.com/docs/api#projects_update). * @summary Updates project settings (name, description, reference language, fallback language). If optional parameters are not sent, their respective fields are not updated. * @param {number} id * @param {string} [apiToken] * @param {string} [name] * @param {string} [description] * @param {string} [referenceLanguage] * @param {string} [fallbackLanguage] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsUpdate(id: number, apiToken?: string, name?: string, description?: string, referenceLanguage?: string, fallbackLanguage?: string, options?: RawAxiosRequestConfig): Promise>; /** * Upload. More details in the [documentation](https://poeditor.com/docs/api#projects_upload). * @summary Updates terms / translations - No more than one request every 20 seconds. * @param {ProjectsUploadUpdatingEnum} updating * @param {File} file Uploaded file (.po, .xls or any of the supported file formats) * @param {string} [apiToken] * @param {number} [id] * @param {string} [language] The language code (Required only if `updating` is terms_translations or translations). When using `terms_translations` with `.xcstrings` file format, leave it empty to import all the languages in the file. * @param {ProjectsUploadOverwriteEnum} [overwrite] Set it to 1 if you want to overwrite translations * @param {ProjectsUploadSyncTermsEnum} [syncTerms] Set it to 1 if you want to sync your terms (terms that are not found in the uploaded file will be deleted from project and the new ones added). Ignored if `updating` = translations. * @param {string} [tags] Add tags to the project terms; available when updating terms or terms_translations; you can use the following keys: \\\"all\\\" - for the all the imported terms, \\\"new\\\" - for the terms which arent already in the project, \\\"obsolete\\\" - for the terms which are in the project but not in the imported file and \\\"overwritten_translations\\\" - for the terms for which translations change * @param {ProjectsUploadReadFromSourceEnum} [readFromSource] For .xliff format only - set it to 1 if you want to import translations from the source tag * @param {ProjectsUploadFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsUpload(updating: ProjectsUploadUpdatingEnum, file: File, apiToken?: string, id?: number, language?: string, overwrite?: ProjectsUploadOverwriteEnum, syncTerms?: ProjectsUploadSyncTermsEnum, tags?: string, readFromSource?: ProjectsUploadReadFromSourceEnum, fuzzyTrigger?: ProjectsUploadFuzzyTriggerEnum, options?: RawAxiosRequestConfig): Promise>; /** * View Project Details. More details in the [documentation](https://poeditor.com/docs/api#projects_view). * @summary Returns projects details * @param {number} id * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi */ projectsView(id: number, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ProjectsExportTypeEnum: { readonly Arb: "arb"; readonly Csv: "csv"; readonly Ini: "ini"; readonly KeyValueJson: "key_value_json"; readonly I18next: "i18next"; readonly Json: "json"; readonly Po: "po"; readonly Pot: "pot"; readonly Mo: "mo"; readonly Properties: "properties"; readonly Resw: "resw"; readonly Resx: "resx"; readonly Ts: "ts"; readonly AppleStrings: "apple_strings"; readonly Xliff: "xliff"; readonly Xliff12: "xliff_1_2"; readonly Xlf: "xlf"; readonly Xmb: "xmb"; readonly Xtb: "xtb"; readonly Rise360Xliff: "rise_360_xliff"; readonly Xls: "xls"; readonly Xlsx: "xlsx"; readonly AndroidStrings: "android_strings"; readonly Yml: "yml"; readonly Php: "php"; }; export type ProjectsExportTypeEnum = (typeof ProjectsExportTypeEnum)[keyof typeof ProjectsExportTypeEnum]; /** * @export */ export declare const ProjectsExportOptionsEnum: { readonly Unquoted1: "[{\"unquoted\": 1}]"; readonly Unencoded1: "[{\"unencoded\": 1}]"; readonly ExportAll1: "[{\"export_all\": 1}]"; }; export type ProjectsExportOptionsEnum = (typeof ProjectsExportOptionsEnum)[keyof typeof ProjectsExportOptionsEnum]; /** * @export */ export declare const ProjectsUploadUpdatingEnum: { readonly Terms: "terms"; readonly Translations: "translations"; readonly TermsTranslations: "terms_translations"; }; export type ProjectsUploadUpdatingEnum = (typeof ProjectsUploadUpdatingEnum)[keyof typeof ProjectsUploadUpdatingEnum]; /** * @export */ export declare const ProjectsUploadOverwriteEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectsUploadOverwriteEnum = (typeof ProjectsUploadOverwriteEnum)[keyof typeof ProjectsUploadOverwriteEnum]; /** * @export */ export declare const ProjectsUploadSyncTermsEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectsUploadSyncTermsEnum = (typeof ProjectsUploadSyncTermsEnum)[keyof typeof ProjectsUploadSyncTermsEnum]; /** * @export */ export declare const ProjectsUploadReadFromSourceEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectsUploadReadFromSourceEnum = (typeof ProjectsUploadReadFromSourceEnum)[keyof typeof ProjectsUploadReadFromSourceEnum]; /** * @export */ export declare const ProjectsUploadFuzzyTriggerEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ProjectsUploadFuzzyTriggerEnum = (typeof ProjectsUploadFuzzyTriggerEnum)[keyof typeof ProjectsUploadFuzzyTriggerEnum]; /** * TermsApi - axios parameter creator * @export */ export declare const TermsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_add). * @summary Adds terms to project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsAdd: (id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Add Comment. More details in the [documentation](https://poeditor.com/docs/api#terms_add_comment). * @summary Adds comments to existing terms. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsAddComment: (id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Delete Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_delete). * @summary Deletes terms from project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsDelete: (id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * List Project Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_list). * @summary Returns project\'s terms and translations if the argument language is provided. * @param {number} id * @param {string} [apiToken] * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsList: (id: number, apiToken?: string, language?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_update). * @summary Updates project terms. Lets you change the text, context, reference, plural and tags. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {TermsUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsUpdate: (id: number, data: string, apiToken?: string, fuzzyTrigger?: TermsUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * TermsApi - functional programming interface * @export */ export declare const TermsApiFp: (configuration?: Configuration) => { /** * Add Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_add). * @summary Adds terms to project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsAdd(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add Comment. More details in the [documentation](https://poeditor.com/docs/api#terms_add_comment). * @summary Adds comments to existing terms. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsAddComment(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_delete). * @summary Deletes terms from project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsDelete(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Project Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_list). * @summary Returns project\'s terms and translations if the argument language is provided. * @param {number} id * @param {string} [apiToken] * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsList(id: number, apiToken?: string, language?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_update). * @summary Updates project terms. Lets you change the text, context, reference, plural and tags. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {TermsUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsUpdate(id: number, data: string, apiToken?: string, fuzzyTrigger?: TermsUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TermsApi - factory interface * @export */ export declare const TermsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_add). * @summary Adds terms to project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsAdd(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Add Comment. More details in the [documentation](https://poeditor.com/docs/api#terms_add_comment). * @summary Adds comments to existing terms. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsAddComment(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_delete). * @summary Deletes terms from project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsDelete(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * List Project Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_list). * @summary Returns project\'s terms and translations if the argument language is provided. * @param {number} id * @param {string} [apiToken] * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsList(id: number, apiToken?: string, language?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_update). * @summary Updates project terms. Lets you change the text, context, reference, plural and tags. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {TermsUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} */ termsUpdate(id: number, data: string, apiToken?: string, fuzzyTrigger?: TermsUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TermsApi - object-oriented interface * @export * @class TermsApi * @extends {BaseAPI} */ export declare class TermsApi extends BaseAPI { /** * Add Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_add). * @summary Adds terms to project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TermsApi */ termsAdd(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Add Comment. More details in the [documentation](https://poeditor.com/docs/api#terms_add_comment). * @summary Adds comments to existing terms. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TermsApi */ termsAddComment(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Delete Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_delete). * @summary Deletes terms from project. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TermsApi */ termsDelete(id: number, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * List Project Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_list). * @summary Returns project\'s terms and translations if the argument language is provided. * @param {number} id * @param {string} [apiToken] * @param {string} [language] The language code * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TermsApi */ termsList(id: number, apiToken?: string, language?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update Terms. More details in the [documentation](https://poeditor.com/docs/api#terms_update). * @summary Updates project terms. Lets you change the text, context, reference, plural and tags. * @param {number} id * @param {string} data JSON format * @param {string} [apiToken] * @param {TermsUpdateFuzzyTriggerEnum} [fuzzyTrigger] Set it to 1 to mark corresponding translations from the other languages as fuzzy for the updated values * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TermsApi */ termsUpdate(id: number, data: string, apiToken?: string, fuzzyTrigger?: TermsUpdateFuzzyTriggerEnum, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const TermsUpdateFuzzyTriggerEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type TermsUpdateFuzzyTriggerEnum = (typeof TermsUpdateFuzzyTriggerEnum)[keyof typeof TermsUpdateFuzzyTriggerEnum]; /** * TranslationsApi - axios parameter creator * @export */ export declare const TranslationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_add). * @summary Adds translations to project. If translation exists, it will not overwrite it. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsAdd: (id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_automatic). * @summary Updates existing translations. * @param {number} id * @param {TranslationsAutomaticProviderEnum} provider * @param {string} [apiToken] * @param {string} [sourceLanguage] The language code * @param {string} [providerSourceLanguage] The language code * @param {string} [targetLanguages] A JSON of the languages to translate to * @param {string} [_options] A JSON of the advanced options you want to use with the selected provider. Possible options include the POEditor tag of the strings you want to send for translation and some provider-specific options * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsAutomatic: (id: number, provider: TranslationsAutomaticProviderEnum, apiToken?: string, sourceLanguage?: string, providerSourceLanguage?: string, targetLanguages?: string, _options?: string, options?: RawAxiosRequestConfig) => Promise; /** * Delete Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_delete). * @summary Deletes translations from specified language. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsDelete: (id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_update). * @summary Updates existing translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsUpdate: (id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * TranslationsApi - functional programming interface * @export */ export declare const TranslationsApiFp: (configuration?: Configuration) => { /** * Add Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_add). * @summary Adds translations to project. If translation exists, it will not overwrite it. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsAdd(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_automatic). * @summary Updates existing translations. * @param {number} id * @param {TranslationsAutomaticProviderEnum} provider * @param {string} [apiToken] * @param {string} [sourceLanguage] The language code * @param {string} [providerSourceLanguage] The language code * @param {string} [targetLanguages] A JSON of the languages to translate to * @param {string} [_options] A JSON of the advanced options you want to use with the selected provider. Possible options include the POEditor tag of the strings you want to send for translation and some provider-specific options * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsAutomatic(id: number, provider: TranslationsAutomaticProviderEnum, apiToken?: string, sourceLanguage?: string, providerSourceLanguage?: string, targetLanguages?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_delete). * @summary Deletes translations from specified language. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsDelete(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_update). * @summary Updates existing translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsUpdate(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TranslationsApi - factory interface * @export */ export declare const TranslationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_add). * @summary Adds translations to project. If translation exists, it will not overwrite it. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsAdd(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_automatic). * @summary Updates existing translations. * @param {number} id * @param {TranslationsAutomaticProviderEnum} provider * @param {string} [apiToken] * @param {string} [sourceLanguage] The language code * @param {string} [providerSourceLanguage] The language code * @param {string} [targetLanguages] A JSON of the languages to translate to * @param {string} [_options] A JSON of the advanced options you want to use with the selected provider. Possible options include the POEditor tag of the strings you want to send for translation and some provider-specific options * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsAutomatic(id: number, provider: TranslationsAutomaticProviderEnum, apiToken?: string, sourceLanguage?: string, providerSourceLanguage?: string, targetLanguages?: string, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_delete). * @summary Deletes translations from specified language. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsDelete(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_update). * @summary Updates existing translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} */ translationsUpdate(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TranslationsApi - object-oriented interface * @export * @class TranslationsApi * @extends {BaseAPI} */ export declare class TranslationsApi extends BaseAPI { /** * Add Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_add). * @summary Adds translations to project. If translation exists, it will not overwrite it. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TranslationsApi */ translationsAdd(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_automatic). * @summary Updates existing translations. * @param {number} id * @param {TranslationsAutomaticProviderEnum} provider * @param {string} [apiToken] * @param {string} [sourceLanguage] The language code * @param {string} [providerSourceLanguage] The language code * @param {string} [targetLanguages] A JSON of the languages to translate to * @param {string} [_options] A JSON of the advanced options you want to use with the selected provider. Possible options include the POEditor tag of the strings you want to send for translation and some provider-specific options * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TranslationsApi */ translationsAutomatic(id: number, provider: TranslationsAutomaticProviderEnum, apiToken?: string, sourceLanguage?: string, providerSourceLanguage?: string, targetLanguages?: string, _options?: string, options?: RawAxiosRequestConfig): Promise>; /** * Delete Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_delete). * @summary Deletes translations from specified language. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TranslationsApi */ translationsDelete(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update Translations. More details in the [documentation](https://poeditor.com/docs/api#translations_update). * @summary Updates existing translations. * @param {number} id * @param {string} language The language code * @param {string} data JSON format * @param {string} [apiToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TranslationsApi */ translationsUpdate(id: number, language: string, data: string, apiToken?: string, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const TranslationsAutomaticProviderEnum: { readonly Google: "google"; readonly Microsoft: "microsoft"; readonly Deepl: "deepl"; }; export type TranslationsAutomaticProviderEnum = (typeof TranslationsAutomaticProviderEnum)[keyof typeof TranslationsAutomaticProviderEnum]; //# sourceMappingURL=api.d.ts.map