/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/v2/user": { /** * Get user info * @description Returns information about currently authenticated user. */ get: operations["getInfo_2"]; }; "/v2/projects/namespaces/{id}": { /** Update namespace */ put: operations["update_2"]; }; "/v2/projects/keys/{id}/disabled-languages": { /** * Get disabled languages * @description Returns languages, in which key is disabled */ get: operations["getDisabledLanguages_1"]; /** * Set disabled languages * @description Sets languages, in which key is disabled */ put: operations["setDisabledLanguages_1"]; }; "/v2/projects/keys/{id}/complex-update": { /** * Edit key and related data * @description Edits key name, translations, tags, screenshots, and other data */ put: operations["complexEdit_1"]; }; "/v2/projects/keys/{id}": { /** Get one key */ get: operations["get_7"]; /** Edit key name */ put: operations["edit_1"]; }; "/v2/projects/tag-complex": { /** Execute complex tag operation */ put: operations["executeComplexTagOperation_1"]; }; "/v2/projects/keys/{keyId}/tags": { /** * Tag key * @description Tags a key with tag. If tag with provided name doesn't exist, it is created */ put: operations["tagKey_1"]; }; "/v2/projects/import/result/languages/{languageId}/translations/{translationId}/resolve/set-override": { /** * Resolve conflict (override) * @description Resolves translation conflict. The old translation will be overridden. */ put: operations["resolveTranslationSetOverride_1"]; }; "/v2/projects/import/result/languages/{languageId}/translations/{translationId}/resolve/set-keep-existing": { /** * Resolve conflict (keep existing) * @description Resolves translation conflict. The old translation will be kept. */ put: operations["resolveTranslationSetKeepExisting_1"]; }; "/v2/projects/import/result/languages/{languageId}/resolve-all/set-override": { /** * Resolve all translation conflicts (override) * @description Resolves all translation conflicts for provided language. The old translations will be overridden. */ put: operations["resolveTranslationSetOverride_3"]; }; "/v2/projects/import/result/languages/{languageId}/resolve-all/set-keep-existing": { /** * Resolve all translation conflicts (keep existing) * @description Resolves all translation conflicts for provided language. The old translations will be kept. */ put: operations["resolveTranslationSetKeepExisting_3"]; }; "/v2/projects/import/result/languages/{importLanguageId}/select-existing/{existingLanguageId}": { /** * Pair existing language * @description Sets existing language to pair with language to import. Data will be imported to selected existing language when applied. */ put: operations["selectExistingLanguage_1"]; }; "/v2/projects/import/result/languages/{importLanguageId}/reset-existing": { /** * Reset existing language pairing * @description Resets existing language paired with language to import. */ put: operations["resetExistingLanguage_1"]; }; "/v2/projects/import/result/files/{fileId}/select-namespace": { /** * Select namespace * @description Sets namespace for file to import. */ put: operations["selectNamespace_1"]; }; "/v2/projects/import/apply-streaming": { /** * Apply import (streaming) * @description Imports the data prepared in previous step. Streams current status. */ put: operations["applyImportStreaming_1"]; }; "/v2/projects/import/apply": { /** * Apply import * @description Imports the data prepared in previous step */ put: operations["applyImport_1"]; }; "/v2/projects/import-settings": { /** * Get Import Settings * @description Returns import settings for the authenticated user and the project. */ get: operations["get_11"]; /** * Set Import Settings * @description Stores import settings for the authenticated user and the project. */ put: operations["store_1"]; }; "/v2/projects/batch-jobs/{id}/cancel": { /** * Stop batch operation * @description Stops batch operation if possible. */ put: operations["cancel_1"]; }; "/v2/projects/translations/{translationId}/set-state/{state}": { /** Set translation state */ put: operations["setTranslationState_1"]; }; "/v2/projects/translations/{translationId}/comments/{commentId}/set-state/{state}": { /** Set state of translation comment */ put: operations["setState_1"]; }; "/v2/projects/translations/{translationId}/comments/{commentId}": { /** Get one translation comment */ get: operations["get_15"]; /** Update translation comment */ put: operations["update_6"]; /** Delete translation comment */ delete: operations["delete_9"]; }; "/v2/projects/translations/{translationId}/set-outdated-flag/{state}": { /** * Set outdated value * @description Set's "outdated" flag indicating the base translation was changed without updating current translation. */ put: operations["setOutdated_1"]; }; "/v2/projects/translations/{translationId}/dismiss-auto-translated-state": { /** * Dismiss auto-translated * @description Removes "auto translated" indication */ put: operations["dismissAutoTranslatedState_1"]; }; "/v2/projects/translations": { /** Get translations in project */ get: operations["getTranslations_1"]; /** * Update translations for existing key * @description Sets translations for existing key */ put: operations["setTranslations_1"]; /** * Create key or update translations * @description Sets translations for existing key or creates new key and sets the translations to it. */ post: operations["createOrUpdateTranslations_1"]; }; "/v2/projects/languages/{languageId}": { /** Get one language */ get: operations["get_17"]; /** Update language */ put: operations["editLanguage_1"]; /** Delete specific language */ delete: operations["deleteLanguage_3"]; }; "/v2/projects/keys/{keyId}/auto-translate": { /** * Auto translates keys * @description Uses enabled auto-translation methods. * You need to set at least one of useMachineTranslation or useTranslationMemory to true. * * This will replace the the existing translation with the result obtained from specified source! */ put: operations["autoTranslate_1"]; }; "/v2/organizations/{id}": { /** Get one organization */ get: operations["get_20"]; }; "/v2/projects": { /** * Get all permitted * @description Returns all projects where current user has any permission */ get: operations["getAll"]; /** * Create project * @description Creates a new project with languages and initial settings. */ post: operations["createProject"]; }; "/v2/projects/keys/info": { /** * Get key info * @description Returns information about keys. (KeyData, Screenshots, Translation in specified language)If key is not found, it's not included in the response. */ post: operations["getInfo_1"]; }; "/v2/projects/keys/import-resolvable": { /** * Import keys (resolvable) * @description Import's new keys with translations. Translations can be updated, when specified. */ post: operations["importKeys_1"]; }; "/v2/projects/keys/import": { /** * Import keys * @description Imports new keys with translations. If key already exists, its translations and tags are not updated. */ post: operations["importKeys_3"]; }; "/v2/projects/keys/create": { /** Create new key */ post: operations["create_3"]; }; "/v2/projects/keys": { /** Get all keys */ get: operations["getAll_2"]; /** Create new key */ post: operations["create_4"]; /** * Delete one or multiple keys (post) * @description Delete one or multiple keys by their IDs in request body. Useful for larger requests esxceeding allowed URL length. */ delete: operations["delete_5"]; }; "/v2/projects/start-batch-job/untag-keys": { /** Remove tags */ post: operations["untagKeys_1"]; }; "/v2/projects/start-batch-job/tag-keys": { /** Add tags */ post: operations["tagKeys_1"]; }; "/v2/projects/start-batch-job/set-translation-state": { /** Set translation state */ post: operations["setTranslationState_3"]; }; "/v2/projects/start-batch-job/set-keys-namespace": { /** Set keys namespace */ post: operations["setKeysNamespace_1"]; }; "/v2/projects/start-batch-job/pre-translate-by-tm": { /** * Pre-translate by TM * @description Pre-translate provided keys to provided languages by TM. */ post: operations["translate_1"]; }; "/v2/projects/start-batch-job/machine-translate": { /** * Machine Translation * @description Translate provided keys to provided languages through primary MT provider. */ post: operations["machineTranslation_1"]; }; "/v2/projects/start-batch-job/delete-keys": { /** Delete keys */ post: operations["deleteKeys_1"]; }; "/v2/projects/start-batch-job/copy-translations": { /** * Copy translation values * @description Copy translation values from one language to other languages. */ post: operations["copyTranslations_1"]; }; "/v2/projects/start-batch-job/clear-translations": { /** * Clear translation values * @description Clear translation values for provided keys in selected languages. */ post: operations["clearTranslations_1"]; }; "/v2/projects/single-step-import": { /** * Single step import * @description Unlike the /v2/projects/{projectId}/import endpoint, imports the data in single request by provided files and parameters. This is useful for automated importing via API or CLI. */ post: operations["doImport_1"]; }; "/v2/projects/import": { /** * Add files * @description Prepares provided files to import. */ post: operations["addFiles_1"]; /** * Delete * @description Deletes prepared import data. */ delete: operations["cancelImport_1"]; }; "/v2/projects/export": { /** Export data */ get: operations["export_1"]; /** * Export data (post) * @description Exports data (post). Useful when exceeding allowed URL size. */ post: operations["exportPost_1"]; }; "/v2/projects/big-meta": { /** * Store Big Meta * @description Stores a bigMeta for a project */ post: operations["store_3"]; }; "/v2/projects/translations/{translationId}/comments": { /** * Get translation comments * @description Returns translation comments of translation */ get: operations["getAll_6"]; /** Create translation comment */ post: operations["create_8"]; }; "/v2/projects/translations/create-comment": { /** * Create translation comment * @description Creates a translation comment. Empty translation is stored, when not exists. */ post: operations["create_10"]; }; "/v2/projects/suggest/translation-memory": { /** * Get suggestions from translation memory * @description Suggests machine translations from translation memory. The result is always sorted by similarity, so sorting is not supported. */ post: operations["suggestTranslationMemory_1"]; }; "/v2/projects/suggest/machine-translations-streaming": { /** * Get machine translation suggestions (streaming) * @description Suggests machine translations from enabled services. The results are streamed to the output in ndjson format. If an error occurs when for any service provider used, the error information is returned as a part of the result item, while the response has 200 status code. */ post: operations["suggestMachineTranslationsStreaming_1"]; }; "/v2/projects/suggest/machine-translations": { /** * Get machine translation suggestions * @description Suggests machine translations from enabled services */ post: operations["suggestMachineTranslations_1"]; }; "/v2/projects/languages": { /** Get all languages */ get: operations["getAll_8"]; /** Create language */ post: operations["createLanguage_1"]; }; "/v2/projects/keys/{keyId}/screenshots": { /** Get screenshots */ get: operations["getKeyScreenshots"]; /** Upload screenshot */ post: operations["uploadScreenshot"]; }; "/v2/organizations": { /** * Get all permitted organizations * @description Returns all organizations, which is current user allowed to view */ get: operations["getAll_10"]; /** Create organization */ post: operations["create_12"]; }; "/v2/image-upload": { /** Upload an image for later use */ post: operations["upload"]; }; "/v2/projects/used-namespaces": { /** * Get used namespaces * @description Returns all used project namespaces. Response contains default (null) namespace if used. */ get: operations["getUsedNamespaces_1"]; }; "/v2/projects/namespaces": { /** Get namespaces */ get: operations["getAllNamespaces_1"]; }; "/v2/projects/namespace-by-name/{name}": { /** * Get namespace by name * @description Returns information about a namespace by its name */ get: operations["getByName_1"]; }; "/v2/projects/keys/search": { /** * Search for keys * @description This endpoint helps you to find desired key by keyName, base translation or translation in specified language. */ get: operations["searchForKey_1"]; }; "/v2/projects/activity": { /** Get project activity */ get: operations["getActivity_1"]; }; "/v2/projects/tags": { /** Get tags */ get: operations["getAll_4"]; }; "/v2/projects/my-batch-jobs": { /** * List user batch operations * @description List all batch operations started by current user */ get: operations["myList_1"]; }; "/v2/projects/keys/{id}/big-meta": { /** Get Big Meta for key */ get: operations["getBigMeta_1"]; }; "/v2/projects/import/result/languages/{languageId}/translations": { /** * Get translations * @description Returns translations prepared to import. */ get: operations["getImportTranslations_1"]; }; "/v2/projects/import/result/languages/{languageId}": { /** * Get import language * @description Returns language prepared to import. */ get: operations["getImportLanguage_1"]; /** * Delete language * @description Deletes language prepared to import. */ delete: operations["deleteLanguage_1"]; }; "/v2/projects/import/result/files/{importFileId}/issues": { /** * Get file issues * @description Returns issues for uploaded file. */ get: operations["getImportFileIssues_1"]; }; "/v2/projects/import/result": { /** * Get result * @description Returns the result of preparation. */ get: operations["getImportResult_1"]; }; "/v2/projects/import/all-namespaces": { /** * Get namespaces * @description Returns all existing and imported namespaces */ get: operations["getAllNamespaces_3"]; }; "/v2/projects/current-batch-jobs": { /** * Get all running and pending batch operations * @description Returns all running and pending batch operations. Completed batch operations are returned only if they are not older than 1 hour. If user doesn't have permission to view all batch operations, only their operations are returned. */ get: operations["currentJobs_1"]; }; "/v2/projects/batch-jobs/{id}": { /** Get batch operation */ get: operations["get_13"]; }; "/v2/projects/batch-jobs": { /** List batch operations */ get: operations["list_4"]; }; "/v2/projects/translations/{translationId}/history": { /** * Get translation history * @description Sorting is not supported for supported. It is automatically sorted from newest to oldest. */ get: operations["getTranslationHistory_1"]; }; "/v2/projects/translations/{languages}": { /** * Get all translations * @description Returns all translations for specified languages */ get: operations["getAllTranslations_1"]; }; "/v2/projects/translations/select-all": { /** * Select keys * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. */ get: operations["selectKeys_1"]; }; "/v2/projects/keys/select": { /** * Select keys * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. */ get: operations["selectKeys_3"]; }; "/v2/projects/stats/daily-activity": { /** Get project daily amount of events */ get: operations["getProjectDailyActivity_1"]; }; "/v2/projects/stats": { /** Get project stats */ get: operations["getProjectStats_1"]; }; "/v2/pats/current": { /** * Return current PAK * @description Returns current Personal Access Token. If the request is not authenticated with a Personal Access Token, it will return 400 response status. */ get: operations["getCurrent"]; }; "/v2/organizations/{slug}": { /** Get organization by slug */ get: operations["get_19"]; }; "/v2/organizations/{organizationId}/machine-translation-credit-balance": { /** * Get credit balance for organization * @description Returns machine translation credit balance for organization */ get: operations["getOrganizationCredits"]; }; "/v2/api-keys/current": { /** * Get current API key info * @description Returns info the API key which user currently authenticated with. Otherwise responds with 400 status code. */ get: operations["getCurrent_1"]; }; "/v2/api-keys/current-permissions": { /** * Get current permission info * @description Returns current PAK or PAT permissions for current user, api-key and project */ get: operations["getCurrentPermissions"]; }; "/v2/projects/keys/{ids}": { /** Delete one or multiple keys */ delete: operations["delete_3"]; }; "/v2/projects/keys/{keyId}/tags/{tagId}": { /** * Remove tag * @description Removes tag with provided id from key with provided id */ delete: operations["removeTag_1"]; }; "/v2/projects/keys/{keyId}/screenshots/{ids}": { /** Delete screenshots */ delete: operations["deleteScreenshots"]; }; "/v2/image-upload/{ids}": { /** Delete uploaded images */ delete: operations["delete_12"]; }; } export type webhooks = Record; export interface components { schemas: { ErrorResponseTyped: { /** @enum {string} */ code: "unauthenticated" | "api_access_forbidden" | "api_key_not_found" | "invalid_api_key" | "invalid_project_api_key" | "project_api_key_expired" | "bad_credentials" | "mfa_enabled" | "invalid_otp_code" | "mfa_not_enabled" | "can_not_revoke_own_permissions" | "data_corrupted" | "invitation_code_does_not_exist_or_expired" | "language_tag_exists" | "language_name_exists" | "language_not_found" | "operation_not_permitted" | "registrations_not_allowed" | "project_not_found" | "resource_not_found" | "scope_not_found" | "key_exists" | "third_party_auth_error_message" | "third_party_auth_no_email" | "third_party_auth_no_sub" | "third_party_auth_unknown_error" | "third_party_unauthorized" | "third_party_google_workspace_mismatch" | "username_already_exists" | "username_or_password_invalid" | "user_already_has_permissions" | "user_already_has_role" | "user_not_found" | "file_not_image" | "file_too_big" | "invalid_timestamp" | "email_not_verified" | "missing_callback_url" | "invalid_jwt_token" | "expired_jwt_token" | "general_jwt_error" | "cannot_find_suitable_address_part" | "address_part_not_unique" | "user_is_not_member_of_organization" | "organization_has_no_other_owner" | "user_has_no_project_access" | "user_is_organization_owner" | "cannot_set_your_own_permissions" | "user_is_organization_member" | "property_not_mutable" | "import_language_not_from_project" | "existing_language_not_selected" | "conflict_is_not_resolved" | "language_already_selected" | "cannot_parse_file" | "could_not_resolve_property" | "cannot_add_more_then_100_languages" | "no_languages_provided" | "language_with_base_language_tag_not_found" | "language_not_from_project" | "namespace_not_from_project" | "cannot_delete_base_language" | "key_not_from_project" | "max_screenshots_exceeded" | "translation_not_from_project" | "can_edit_only_own_comment" | "request_parse_error" | "filter_by_value_state_not_valid" | "import_has_expired" | "tag_not_from_project" | "translation_text_too_long" | "invalid_recaptcha_token" | "cannot_leave_owning_project" | "cannot_leave_project_with_organization_role" | "dont_have_direct_permissions" | "tag_too_log" | "too_many_uploaded_images" | "one_or_more_images_not_found" | "screenshot_not_of_key" | "service_not_found" | "too_many_requests" | "translation_not_found" | "out_of_credits" | "key_not_found" | "organization_not_found" | "cannot_find_base_language" | "base_language_not_found" | "no_exported_result" | "cannot_set_your_own_role" | "only_translate_review_or_view_permission_accepts_view_languages" | "oauth2_token_url_not_set" | "oauth2_user_url_not_set" | "email_already_invited_or_member" | "price_not_found" | "invoice_not_from_organization" | "invoice_not_found" | "plan_not_found" | "plan_not_available_any_more" | "no_auto_translation_method" | "cannot_translate_base_language" | "pat_not_found" | "invalid_pat" | "pat_expired" | "operation_unavailable_for_account_type" | "validation_email_is_not_valid" | "current_password_required" | "cannot_create_organization" | "wrong_current_password" | "wrong_param_type" | "expired_super_jwt_token" | "cannot_delete_your_own_account" | "cannot_sort_by_this_column" | "namespace_not_found" | "namespace_exists" | "invalid_authentication_method" | "unknown_sort_property" | "only_review_permission_accepts_state_change_languages" | "only_translate_or_review_permission_accepts_translate_languages" | "cannot_set_language_permissions_for_admin_scope" | "cannot_set_view_languages_without_translations_view_scope" | "cannot_set_translate_languages_without_translations_edit_scope" | "cannot_set_state_change_languages_without_translations_state_edit_scope" | "language_not_permitted" | "scopes_has_to_be_set" | "set_exactly_one_of_scopes_or_type" | "translation_exists" | "import_keys_error" | "provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids" | "multiple_projects_not_supported" | "plan_translation_limit_exceeded" | "feature_not_enabled" | "license_key_not_found" | "cannot_set_view_languages_without_for_level_based_permissions" | "cannot_set_different_translate_and_state_change_languages_for_level_based_permissions" | "cannot_disable_your_own_account" | "subscription_not_found" | "invoice_does_not_have_usage" | "customer_not_found" | "subscription_not_active" | "organization_already_subscribed" | "organization_not_subscribed" | "license_key_used_by_another_instance" | "translation_spending_limit_exceeded" | "credit_spending_limit_exceeded" | "seats_spending_limit_exceeded" | "this_instance_is_already_licensed" | "big_meta_not_from_project" | "mt_service_not_enabled" | "project_not_selected" | "organization_not_selected" | "plan_has_subscribers" | "translation_failed" | "batch_job_not_found" | "key_exists_in_namespace" | "tag_is_blank" | "execution_failed_on_management_error" | "translation_api_rate_limit" | "cannot_finalize_activity" | "formality_not_supported_by_service" | "language_not_supported_by_service" | "rate_limited" | "pat_access_not_allowed" | "pak_access_not_allowed" | "cannot_modify_disabled_translation" | "azure_config_required" | "s3_config_required" | "content_storage_config_required" | "content_storage_test_failed" | "content_storage_config_invalid" | "invalid_connection_string" | "cannot_create_azure_storage_client" | "s3_access_key_required" | "azure_connection_string_required" | "s3_secret_key_required" | "cannot_store_file_to_content_storage" | "unexpected_error_while_publishing_to_content_storage" | "webhook_responded_with_non_200_status" | "unexpected_error_while_executing_webhook" | "content_storage_is_in_use" | "cannot_set_state_for_missing_translation" | "no_project_id_provided" | "license_key_not_provided" | "subscription_already_canceled" | "user_is_subscribed_to_paid_plan" | "cannot_create_free_plan_without_fixed_type" | "cannot_modify_plan_free_status" | "key_id_not_provided" | "free_self_hosted_seat_limit_exceeded" | "advanced_params_not_supported" | "plural_forms_not_found_for_language" | "nested_plurals_not_supported" | "message_is_not_plural" | "content_outside_plural_forms" | "invalid_plural_form" | "multiple_plurals_not_supported" | "custom_values_json_too_long" | "unsupported_po_message_format" | "plural_forms_data_loss" | "current_user_does_not_own_image" | "user_cannot_view_this_organization" | "user_is_not_owner_of_organization" | "pak_created_for_different_project" | "custom_slug_is_only_applicable_for_custom_storage" | "invalid_slug_format" | "batch_job_cancellation_timeout" | "import_failed" | "cannot_add_more_then_1000_languages" | "no_data_to_import" | "multiple_namespaces_mapped_to_single_file" | "multiple_mappings_for_same_file_language_name" | "multiple_mappings_for_null_file_language_name" | "too_many_mappings_for_file" | "missing_placeholder_in_template" | "tag_not_found"; params?: Record[]; }; ErrorResponseBody: { code: string; params?: Record[]; }; Avatar: { large: string; thumbnail: string; }; PrivateUserAccountModel: { /** Format: int64 */ id: number; username: string; name?: string; emailAwaitingVerification?: string; mfaEnabled: boolean; avatar?: components["schemas"]["Avatar"]; /** @enum {string} */ accountType: "LOCAL" | "MANAGED" | "THIRD_PARTY"; /** @enum {string} */ globalServerRole: "USER" | "ADMIN"; deletable: boolean; needsSuperJwtToken: boolean; }; ComputedPermissionModel: { permissionModel?: components["schemas"]["PermissionModel"]; /** @enum {string} */ origin: "ORGANIZATION_BASE" | "DIRECT" | "ORGANIZATION_OWNER" | "NONE" | "SERVER_ADMIN"; /** * @description The user's permission type. This field is null if uses granular permissions * @enum {string} */ type?: "NONE" | "VIEW" | "TRANSLATE" | "REVIEW" | "EDIT" | "MANAGE"; /** * @deprecated * @description Deprecated (use translateLanguageIds). * * List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted. * @example [ * 200001, * 200004 * ] */ permittedLanguageIds?: number[]; /** * @description Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type. * @example [ * "KEYS_EDIT", * "TRANSLATIONS_VIEW" * ] */ scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage")[]; /** * @description List of languages user can translate to. If null, all languages editing is permitted. * @example [ * 200001, * 200004 * ] */ translateLanguageIds?: number[]; /** * @description List of languages user can view. If null, all languages view is permitted. * @example [ * 200001, * 200004 * ] */ viewLanguageIds?: number[]; /** * @description List of languages user can change state to. If null, changing state of all language values is permitted. * @example [ * 200001, * 200004 * ] */ stateChangeLanguageIds?: number[]; }; LanguageModel: { /** Format: int64 */ id: number; /** * @description Language name in english * @example Czech */ name: string; /** * @description Language tag according to BCP 47 definition * @example cs-CZ */ tag: string; /** * @description Language name in this language * @example čeština */ originalName?: string; /** * @description Language flag emoji as UTF-8 emoji * @example 🇨🇿 */ flagEmoji?: string; /** * @description Whether is base language of project * @example false */ base: boolean; }; NamespaceModel: { /** * Format: int64 * @description The id of namespace * @example 10000048 */ id: number; /** @example homepage */ name: string; }; /** * @description Current user's direct permission * @example MANAGE */ PermissionModel: { /** * @description Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type. * @example [ * "KEYS_EDIT", * "TRANSLATIONS_VIEW" * ] */ scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage")[]; /** * @description The user's permission type. This field is null if uses granular permissions * @enum {string} */ type?: "NONE" | "VIEW" | "TRANSLATE" | "REVIEW" | "EDIT" | "MANAGE"; /** * @deprecated * @description Deprecated (use translateLanguageIds). * * List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted. * @example [ * 200001, * 200004 * ] */ permittedLanguageIds?: number[]; /** * @description List of languages user can translate to. If null, all languages editing is permitted. * @example [ * 200001, * 200004 * ] */ translateLanguageIds?: number[]; /** * @description List of languages user can view. If null, all languages view is permitted. * @example [ * 200001, * 200004 * ] */ viewLanguageIds?: number[]; /** * @description List of languages user can change state to. If null, changing state of all language values is permitted. * @example [ * 200001, * 200004 * ] */ stateChangeLanguageIds?: number[]; }; ProjectModel: { /** Format: int64 */ id: number; name: string; description?: string; slug?: string; avatar?: components["schemas"]["Avatar"]; organizationOwner?: components["schemas"]["SimpleOrganizationModel"]; baseLanguage?: components["schemas"]["LanguageModel"]; defaultNamespace?: components["schemas"]["NamespaceModel"]; /** @enum {string} */ organizationRole?: "MEMBER" | "OWNER"; directPermission?: components["schemas"]["PermissionModel"]; computedPermission: components["schemas"]["ComputedPermissionModel"]; /** @description Whether to disable ICU placeholder visualization in the editor and it's support. */ icuPlaceholders: boolean; }; SimpleOrganizationModel: { /** Format: int64 */ id: number; /** @example Beautiful organization */ name: string; /** @example btforg */ slug: string; /** @example This is a beautiful organization full of beautiful and clever people */ description?: string; basePermissions: components["schemas"]["PermissionModel"]; avatar?: components["schemas"]["Avatar"]; }; UpdateNamespaceDto: { name: string; }; SetDisabledLanguagesRequest: { languageIds: number[]; }; CollectionModelLanguageModel: { _embedded?: { languages?: components["schemas"]["LanguageModel"][]; }; }; ComplexEditKeyDto: { /** @description Name of the key */ name: string; namespace?: string; /** @description Translations to update */ translations?: { [key: string]: string; }; /** @description Translation states to update, if not provided states won't be modified */ states?: { [key: string]: "TRANSLATED" | "REVIEWED"; }; /** @description Tags of the key. If not provided tags won't be modified */ tags?: string[]; /** @description IDs of screenshots to delete */ screenshotIdsToDelete?: number[]; /** @description Ids of screenshots uploaded with /v2/image-upload endpoint */ screenshotUploadedImageIds?: number[]; screenshotsToAdd?: components["schemas"]["KeyScreenshotDto"][]; /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; /** @description Description of the key. It's also used as a context for Tolgee AI translator */ description?: string; /** @description If key is pluralized. If it will be reflected in the editor. If null, value won't be modified. */ isPlural?: boolean; /** @description The argument name for the plural. If null, value won't be modified. If isPlural is false, this value will be ignored. */ pluralArgName?: string; /** @description If true, it will fail with 400 (with code plural_forms_data_loss) if plural is disabled and there are plural forms, which would be lost by the action. You can get rid of this warning by setting this value to false. */ warnOnDataLoss?: boolean; /** @description Custom values of the key. If not provided, custom values won't be modified */ custom?: { [key: string]: Record; }; }; KeyInScreenshotPositionDto: { /** Format: int32 */ x: number; /** Format: int32 */ y: number; /** Format: int32 */ width: number; /** Format: int32 */ height: number; }; KeyScreenshotDto: { text?: string; /** * Format: int64 * @description Ids of screenshot uploaded with /v2/image-upload endpoint */ uploadedImageId: number; positions?: components["schemas"]["KeyInScreenshotPositionDto"][]; }; /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ RelatedKeyDto: { namespace?: string; keyName: string; }; KeyInScreenshotModel: { /** Format: int64 */ keyId: number; position?: components["schemas"]["KeyInScreenshotPosition"]; keyName: string; keyNamespace?: string; originalText?: string; }; KeyInScreenshotPosition: { /** Format: int32 */ x: number; /** Format: int32 */ y: number; /** Format: int32 */ width: number; /** Format: int32 */ height: number; }; KeyWithDataModel: { /** * Format: int64 * @description Id of key record */ id: number; /** * @description Name of key * @example this_is_super_key */ name: string; /** * @description Namespace of key * @example homepage */ namespace?: string; /** * @description Description of key * @example This key is used on homepage. It's a label of sign up button. */ description?: string; /** * @description Translations object containing values updated in this request * @example { * "en": { * "id": 100000003, * "text": "This is super translation!" * } * } */ translations: { [key: string]: components["schemas"]["TranslationModel"]; }; /** @description Tags of key */ tags: components["schemas"]["TagModel"][]; /** @description Screenshots of the key */ screenshots: components["schemas"]["ScreenshotModel"][]; /** @description If key is pluralized. If it will be reflected in the editor */ isPlural: boolean; /** @description The argument name for the plural */ pluralArgName?: string; /** @description Custom values of the key */ custom: { [key: string]: Record; }; }; /** @description Screenshots of the key */ ScreenshotModel: { /** Format: int64 */ id: number; /** * @description File name, which may be downloaded from the screenshot path. * * When images are secured. Encrypted timestamp is appended to the filename. */ filename: string; /** * @description Thumbnail file name, which may be downloaded from the screenshot path. * * When images are secured. Encrypted timestamp is appended to the filename. */ thumbnail: string; fileUrl: string; thumbnailUrl: string; /** Format: date-time */ createdAt?: string; keyReferences: components["schemas"]["KeyInScreenshotModel"][]; location?: string; /** Format: int32 */ width?: number; /** Format: int32 */ height?: number; }; /** @description Tags of key */ TagModel: { /** Format: int64 */ id: number; name: string; }; /** * @description Translations object containing values updated in this request * @example { * "en": { * "id": 100000003, * "text": "This is super translation!" * } * } */ TranslationModel: { /** * Format: int64 * @description Id of translation record */ id: number; /** @description Translation text */ text?: string; /** * @description State of translation * @enum {string} */ state: "UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED"; /** @description Whether base language translation was changed after this translation was updated */ outdated: boolean; /** @description Was translated using Translation Memory or Machine translation service? */ auto: boolean; /** * @description Which machine translation service was used to auto translate this * @enum {string} */ mtProvider?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; }; EditKeyDto: { name: string; namespace?: string; /** * @description Description of the key * @example This key is used on homepage. It's a label of sign up button. */ description?: string; }; KeyModel: { /** * Format: int64 * @description Id of key record */ id: number; /** * @description Name of key * @example this_is_super_key */ name: string; /** * @description Namespace of key * @example homepage */ namespace?: string; /** * @description Description of key * @example This key is used on homepage. It's a label of sign up button. */ description?: string; /** @description Custom values of the key */ custom?: { [key: string]: Record; }; }; ComplexTagKeysRequest: { /** @description Include keys filtered by the provided key information */ filterKeys?: components["schemas"]["KeyId"][]; /** @description Exclude keys filtered by the provided key information */ filterKeysNot?: components["schemas"]["KeyId"][]; /** @description Include keys filtered by the provided tag information. This filter supports wildcards. For example, `draft-*` will match all tags starting with `draft-`. */ filterTag?: string[]; /** @description Exclude keys filtered by the provided tag information. This filter supports wildcards. For example, `draft-*` will match all tags starting with `draft-`. */ filterTagNot?: string[]; /** @description Specified tags will be added to filtered keys */ tagFiltered?: string[]; /** @description Specified tags will be removed from filtered keys. It supports wildcards. For example, `draft-*` will remove all tags starting with `draft-`. */ untagFiltered?: string[]; /** @description Specified tags will be added to keys not filtered by any of the specified filters. */ tagOther?: string[]; /** @description Specified tags will be removed from keys not filtered by any of the specified filters. It supports wildcards. For example, `draft-*` will remove all tags starting with `draft-`. */ untagOther?: string[]; }; /** @description Exclude keys filtered by the provided key information */ KeyId: { name?: string; namespace?: string; /** * Format: int64 * @description If key id is provided, name and namespace are ignored. */ id?: number; }; TagKeyDto: { name: string; }; SetFileNamespaceRequest: { namespace?: string; }; StreamingResponseBody: Record; ImportSettingsRequest: { /** @description If true, key descriptions will be overridden by the import */ overrideKeyDescriptions: boolean; /** @description If true, placeholders from other formats will be converted to ICU when possible */ convertPlaceholdersToIcu: boolean; }; ImportSettingsModel: { /** @description If true, key descriptions will be overridden by the import */ overrideKeyDescriptions: boolean; /** @description If true, placeholders from other formats will be converted to ICU when possible */ convertPlaceholdersToIcu: boolean; }; /** @description User who created the comment */ SimpleUserAccountModel: { /** Format: int64 */ id: number; username: string; name?: string; avatar?: components["schemas"]["Avatar"]; deleted: boolean; }; TranslationCommentModel: { /** * Format: int64 * @description Id of translation comment record */ id: number; /** @description Text of comment */ text: string; /** * @description State of translation * @enum {string} */ state: "RESOLUTION_NOT_NEEDED" | "NEEDS_RESOLUTION" | "RESOLVED"; author: components["schemas"]["SimpleUserAccountModel"]; /** * Format: date-time * @description Date when it was created */ createdAt: string; /** * Format: date-time * @description Date when it was updated */ updatedAt: string; }; TranslationCommentDto: { text: string; /** @enum {string} */ state: "RESOLUTION_NOT_NEEDED" | "NEEDS_RESOLUTION" | "RESOLVED"; }; SetTranslationsWithKeyDto: { /** * @description Key name to set translations for * @example what_a_key_to_translate */ key: string; /** @description The namespace of the key. (When empty or null default namespace will be used) */ namespace?: string; /** * @description Object mapping language tag to translation * @example { * "en": "What a translated value!", * "cs": "Jaká to přeložená hodnota!" * } */ translations: { [key: string]: string; }; /** * @description List of languages to return translations for. * * If not provided, only modified translation will be provided. * * @example [ * "en", * "de", * "fr" * ] */ languagesToReturn?: string[]; }; SetTranslationsResponseModel: { /** * Format: int64 * @description Id of key record */ keyId: number; /** * @description Name of key * @example this_is_super_key */ keyName: string; /** * @description The namespace of the key * @example homepage */ keyNamespace?: string; keyIsPlural: boolean; /** * @description Translations object containing values updated in this request * @example { * "en": { * "id": 100000003, * "text": "This is super translation!" * } * } */ translations: { [key: string]: components["schemas"]["TranslationModel"]; }; }; LanguageRequest: { /** * @description Language name in english * @example Czech */ name: string; /** * @description Language name in this language * @example čeština */ originalName: string; /** * @description Language tag according to BCP 47 definition * @example cs-CZ */ tag: string; /** * @description Language flag emoji as UTF-8 emoji * @example 🇨🇿 */ flagEmoji?: string; }; OrganizationDto: { /** @example Beautiful organization */ name: string; /** @example This is a beautiful organization full of beautiful and clever people */ description?: string; /** @example btforg */ slug?: string; }; OrganizationModel: { /** Format: int64 */ id: number; /** @example Beautiful organization */ name: string; /** @example btforg */ slug: string; /** @example This is a beautiful organization full of beautiful and clever people */ description?: string; basePermissions: components["schemas"]["PermissionModel"]; /** * @description The role of currently authorized user. * * Can be null when user has direct access to one of the projects owned by the organization. * @enum {string} */ currentUserRole?: "MEMBER" | "OWNER"; avatar?: components["schemas"]["Avatar"]; }; CreateProjectRequest: { name: string; languages: components["schemas"]["LanguageRequest"][]; /** @description Slug of your project used in url e.g. "/v2/projects/what-a-project". If not provided, it will be generated */ slug?: string; /** * Format: int64 * @description Organization to create the project in */ organizationId: number; /** @description Tag of one of created languages, to select it as base language. If not provided, first language will be selected as base. */ baseLanguageTag?: string; /** @description Whether to use ICU placeholder visualization in the editor and it's support. */ icuPlaceholders: boolean; }; GetKeysRequestDto: { keys: components["schemas"]["KeyDefinitionDto"][]; /** @description Tags to return language translations in */ languageTags: string[]; }; KeyDefinitionDto: { name: string; namespace?: string; }; CollectionModelKeyWithDataModel: { _embedded?: { keys?: components["schemas"]["KeyWithDataModel"][]; }; }; ImportKeysResolvableDto: { keys: components["schemas"]["ImportKeysResolvableItemDto"][]; }; ImportKeysResolvableItemDto: { /** * @description Key name to set translations for * @example what_a_key_to_translate */ name: string; /** @description The namespace of the key. (When empty or null default namespace will be used) */ namespace?: string; screenshots?: components["schemas"]["KeyScreenshotDto"][]; /** @description Object mapping language tag to translation */ translations: { [key: string]: components["schemas"]["ImportTranslationResolvableDto"]; }; }; /** @description Object mapping language tag to translation */ ImportTranslationResolvableDto: { /** * @description Translation text * @example Hello! I am a translation! */ text: string; /** * @description Determines, how conflict is resolved. * * - KEEP: Translation is not changed * - OVERRIDE: Translation is overridden * - NEW: New translation is created) * * @example OVERRIDE * @enum {string} */ resolution: "KEEP" | "OVERRIDE" | "NEW"; }; KeyImportResolvableResultModel: { /** @description List of keys */ keys: components["schemas"]["KeyModel"][]; /** @description Map uploadedImageId to screenshot */ screenshots: { [key: string]: components["schemas"]["ScreenshotModel"]; }; }; ImportKeysDto: { keys: components["schemas"]["ImportKeysItemDto"][]; }; ImportKeysItemDto: { /** * @description Key name to set translations for * @example what_a_key_to_translate */ name: string; /** @description The namespace of the key. (When empty or null default namespace will be used) */ namespace?: string; /** * @description Description of key * @example This key is used on homepage. It's a label of sign up button. */ description?: string; /** * @description Object mapping language tag to translation * @example { * "en": "What a translated value!", * "cs": "Jaká to přeložená hodnota!" * } */ translations: { [key: string]: string; }; /** * @description Tags of the key * @example [ * "homepage", * "user-profile" * ] */ tags?: string[]; }; CreateKeyDto: { /** @description Name of the key */ name: string; namespace?: string; translations?: { [key: string]: string; }; /** @description Translation states to update, if not provided states won't be modified */ states?: { [key: string]: "TRANSLATED" | "REVIEWED"; }; tags?: string[]; /** @description Ids of screenshots uploaded with /v2/image-upload endpoint */ screenshotUploadedImageIds?: number[]; screenshots?: components["schemas"]["KeyScreenshotDto"][]; /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; /** * @description Description of the key * @example This key is used on homepage. It's a label of sign up button. */ description?: string; /** @description If key is pluralized. If it will be reflected in the editor */ isPlural: boolean; /** @description The argument name for the plural. If null, value will be guessed from the values provided in translations. */ pluralArgName?: string; }; UntagKeysRequest: { keyIds: number[]; tags: string[]; }; BatchJobModel: { /** * Format: int64 * @description Batch job id */ id: number; /** * @description Status of the batch job * @enum {string} */ status: "PENDING" | "RUNNING" | "SUCCESS" | "FAILED" | "CANCELLED" | "DEBOUNCED"; /** * @description Type of the batch job * @enum {string} */ type: "PRE_TRANSLATE_BT_TM" | "MACHINE_TRANSLATE" | "AUTO_TRANSLATE" | "DELETE_KEYS" | "SET_TRANSLATIONS_STATE" | "CLEAR_TRANSLATIONS" | "COPY_TRANSLATIONS" | "TAG_KEYS" | "UNTAG_KEYS" | "SET_KEYS_NAMESPACE" | "AUTOMATION"; /** * Format: int32 * @description Total items, that have been processed so far */ progress: number; /** * Format: int32 * @description Total items */ totalItems: number; author?: components["schemas"]["SimpleUserAccountModel"]; /** * Format: int64 * @description The time when the job created */ createdAt: number; /** * Format: int64 * @description The time when the job was last updated (status change) */ updatedAt: number; /** * Format: int64 * @description The activity revision id, that stores the activity details of the job */ activityRevisionId?: number; /** @description If the job failed, this is the error message */ errorMessage?: string; }; TagKeysRequest: { keyIds: number[]; tags: string[]; }; SetTranslationsStateStateRequest: { keyIds: number[]; languageIds: number[]; /** @enum {string} */ state: "UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED"; }; SetKeysNamespaceRequest: { keyIds: number[]; namespace?: string; }; PreTranslationByTmRequest: { keyIds: number[]; targetLanguageIds: number[]; }; MachineTranslationRequest: { keyIds: number[]; targetLanguageIds: number[]; }; DeleteKeysRequest: { keyIds: number[]; }; CopyTranslationRequest: { keyIds: number[]; /** Format: int64 */ sourceLanguageId: number; targetLanguageIds: number[]; }; ClearTranslationsRequest: { keyIds: number[]; languageIds: number[]; }; /** @description Definition of mapping for each file to import. */ ImportFileMapping: { /** @description Name of the file to import. This is the name of the file provided in `files` request part or in uploaded archive. */ fileName: string; /** @description Namespace to import the file to. If not provided, the key will be imported without namespace. */ namespace?: string; /** * @description Format of the file. If not provided, Tolgee will try to guess the format from the file name or file contents. * * It is recommended to provide these values to prevent any issues with format detection. * @enum {string} */ format?: "JSON_ICU" | "JSON_JAVA" | "JSON_PHP" | "JSON_RUBY" | "JSON_C" | "PO_PHP" | "PO_C" | "PO_JAVA" | "PO_ICU" | "PO_RUBY" | "STRINGS" | "STRINGSDICT" | "APPLE_XLIFF" | "PROPERTIES_ICU" | "PROPERTIES_JAVA" | "PROPERTIES_UNKNOWN" | "ANDROID_XML" | "FLUTTER_ARB" | "YAML_RUBY" | "YAML_JAVA" | "YAML_ICU" | "YAML_PHP" | "YAML_UNKNOWN" | "XLIFF_ICU" | "XLIFF_JAVA" | "XLIFF_PHP" | "XLIFF_RUBY"; /** * @description The existing language tag in the Tolgee platform to which the imported language should be mapped. * * When null, Tolgee will try to guess the language from the file contents or file name. */ languageTag?: string; }; /** * @description Maps the languages from imported files to languages existing in the Tolgee platform. * * Use this field only when your files contain multiple languages (e.g., XLIFF files). * * Otherwise, use the `languageTag` property of `fileMappings`. * * Example: In xliff files, there are `source-language` and `target-language` attributes defined on `file` element. Using this field you can map source and target values to languages stored in the Tolgee Platform. */ LanguageMapping: { /** * @description The language from the imported file. * * For xliff files, this is the `source-language` or the `target-language` attribute value of `file` element. * @example en-US */ importLanguage: string; /** * @description The tag of language existing in the Tolgee platform to which the imported language should be mapped. * @example en-US */ platformLanguageTag: string; }; SingleStepImportRequest: { /** * @description When importing files in structured formats (e.g., JSON, YAML), this field defines the delimiter which will be used in names of imported keys. * @example . */ structureDelimiter?: string; /** * @description Whether to override existing translation data. * * When set to `KEEP`, existing translations will be kept. * * When set to `OVERRIDE`, existing translations will be overwrote. * * When set to `NO_FORCE`, error will be thrown on conflict. * @enum {string} */ forceMode: "OVERRIDE" | "KEEP" | "NO_FORCE"; /** * @description Maps the languages from imported files to languages existing in the Tolgee platform. * * Use this field only when your files contain multiple languages (e.g., XLIFF files). * * Otherwise, use the `languageTag` property of `fileMappings`. * * Example: In xliff files, there are `source-language` and `target-language` attributes defined on `file` element. Using this field you can map source and target values to languages stored in the Tolgee Platform. */ languageMappings?: components["schemas"]["LanguageMapping"][]; /** @description If true, key descriptions will be overridden by the import */ overrideKeyDescriptions: boolean; /** @description If true, placeholders from other formats will be converted to ICU when possible */ convertPlaceholdersToIcu: boolean; /** @description Definition of mapping for each file to import. */ fileMappings: components["schemas"]["ImportFileMapping"][]; /** @description Keys created by this import will be tagged with these tags. It add tags only to new keys. The keys that already exist will not be tagged. */ tagNewKeys: string[]; /** @description If yes, keys from project that were not included in import will be deleted. */ removeOtherKeys?: boolean; }; ImportAddFilesResultModel: { errors: components["schemas"]["ErrorResponseBody"][]; result?: components["schemas"]["PagedModelImportLanguageModel"]; }; ImportLanguageModel: { /** Format: int64 */ id: number; name: string; /** Format: int64 */ existingLanguageId?: number; existingLanguageTag?: string; existingLanguageAbbreviation?: string; existingLanguageName?: string; importFileName: string; /** Format: int64 */ importFileId: number; /** Format: int32 */ importFileIssueCount: number; namespace?: string; /** Format: int32 */ totalCount: number; /** Format: int32 */ conflictCount: number; /** Format: int32 */ resolvedCount: number; }; PageMetadata: { /** Format: int64 */ size?: number; /** Format: int64 */ totalElements?: number; /** Format: int64 */ totalPages?: number; /** Format: int64 */ number?: number; }; PagedModelImportLanguageModel: { _embedded?: { languages?: components["schemas"]["ImportLanguageModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; ExportParams: { /** * @description Languages to be contained in export. * * If null, all languages are exported * @example en */ languages?: string[]; /** * @description Format to export to * @enum {string} */ format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML"; /** * @description Delimiter to structure file content. * * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. * * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), * specific formats like `YAML_RUBY` don't honor this parameter. */ structureDelimiter?: string; /** @description Filter key IDs to be contained in export */ filterKeyId?: number[]; /** @description Filter key IDs not to be contained in export */ filterKeyIdNot?: number[]; /** * @description Filter keys tagged by. * * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ filterTag?: string; /** @description Filter keys tagged by one of provided tags */ filterTagIn?: string[]; /** @description Filter keys not tagged by one of provided tags */ filterTagNotIn?: string[]; /** @description Filter keys with prefix */ filterKeyPrefix?: string; /** @description Filter translations with state. By default, all states except untranslated is exported. */ filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ filterNamespace?: string[]; zip: boolean; /** * @description Message format to be used for export. * * e.g. PHP_PO: Hello %s, ICU: Hello {name}. * * This property is honored only for generic formats like JSON or YAML. * For specific formats like `YAML_RUBY` it's ignored. * @enum {string} */ messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "ICU"; /** * @description This is a template that defines the structure of the resulting .zip file content. * * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, * {androidLanguageTag}, {snakeLanguageTag}, {extension}. * * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, * the English translations of the `home` namespace will be stored in `home/en.json`. * * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). * * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` * but in Android format. (e.g., en-rUS) */ fileStructureTemplate?: string; /** * @description If true, for structured formats (like JSON) arrays are supported. * * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ supportArrays: boolean; }; BigMetaDto: { /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; }; TranslationCommentWithLangKeyDto: { /** Format: int64 */ keyId: number; /** Format: int64 */ languageId: number; text: string; /** @enum {string} */ state: "RESOLUTION_NOT_NEEDED" | "NEEDS_RESOLUTION" | "RESOLVED"; }; TranslationWithCommentModel: { translation: components["schemas"]["TranslationModel"]; comment: components["schemas"]["TranslationCommentModel"]; }; SuggestRequestDto: { /** * Format: int64 * @description Key Id to get results for. Use when key is stored already. */ keyId?: number; /** Format: int64 */ targetLanguageId: number; /** @description Text value of base translation. Useful, when base translation is not stored yet. */ baseText?: string; /** @description Whether base text is plural. This value is ignored if baseText is null. */ isPlural?: boolean; /** @description List of services to use. If null, then all enabled services are used. */ services?: ("GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE")[]; }; PagedModelTranslationMemoryItemModel: { _embedded?: { translationMemoryItems?: components["schemas"]["TranslationMemoryItemModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; TranslationMemoryItemModel: { targetText: string; baseText: string; keyName: string; /** Format: float */ similarity: number; }; SuggestResultModel: { /** * @deprecated * @description String translations provided by enabled services. (deprecated, use `result` instead) * @example * { * "GOOGLE": "This was translated by Google", * "TOLGEE": "This was translated by Tolgee Translator", * } */ machineTranslations?: { [key: string]: string; }; /** * @description Results provided by enabled services. * @example { * "GOOGLE": { * "output": "This was translated by Google", * "contextDescription": null * }, * "TOLGEE": { * "output": "This was translated by Tolgee Translator", * "contextDescription": "This is an example in swagger" * } * } */ result?: { [key: string]: components["schemas"]["TranslationItemModel"]; }; /** @description If true, the base translation was empty and no translation was provided. */ baseBlank: boolean; }; /** * @description Results provided by enabled services. * @example { * "GOOGLE": { * "output": "This was translated by Google", * "contextDescription": null * }, * "TOLGEE": { * "output": "This was translated by Tolgee Translator", * "contextDescription": "This is an example in swagger" * } * } */ TranslationItemModel: { output: string; contextDescription?: string; }; ScreenshotInfoDto: { text?: string; positions?: components["schemas"]["KeyInScreenshotPositionDto"][]; location?: string; }; ImageUploadInfoDto: { location?: string; }; UploadedImageModel: { /** Format: int64 */ id: number; filename: string; fileUrl: string; requestFilename: string; /** Format: date-time */ createdAt: string; location?: string; }; PagedModelProjectModel: { _embedded?: { projects?: components["schemas"]["ProjectModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; CollectionModelUsedNamespaceModel: { _embedded?: { namespaces?: components["schemas"]["UsedNamespaceModel"][]; }; }; UsedNamespaceModel: { /** * Format: int64 * @description The id of namespace. Null for default namespace. * @example 10000048 */ id?: number; /** * @description Name of namespace. Null if default. * @example homepage */ name?: string; }; PagedModelNamespaceModel: { _embedded?: { namespaces?: components["schemas"]["NamespaceModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; KeySearchResultView: { name: string; /** Format: int64 */ id: number; baseTranslation?: string; translation?: string; description?: string; namespace?: string; }; KeySearchSearchResultModel: { view?: components["schemas"]["KeySearchResultView"]; name: string; /** Format: int64 */ id: number; baseTranslation?: string; translation?: string; description?: string; namespace?: string; }; PagedModelKeySearchSearchResultModel: { _embedded?: { keys?: components["schemas"]["KeySearchSearchResultModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; PagedModelKeyModel: { _embedded?: { keys?: components["schemas"]["KeyModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; EntityDescriptionWithRelations: { entityClass: string; /** Format: int64 */ entityId: number; data: { [key: string]: Record; }; }; ExistenceEntityDescription: { entityClass: string; /** Format: int64 */ entityId: number; data: { [key: string]: Record; }; relations: { [key: string]: components["schemas"]["EntityDescriptionWithRelations"]; }; exists?: boolean; }; ModifiedEntityModel: { /** Format: int64 */ entityId: number; description?: { [key: string]: Record; }; modifications?: { [key: string]: components["schemas"]["PropertyModification"]; }; relations?: { [key: string]: components["schemas"]["ExistenceEntityDescription"]; }; exists?: boolean; }; PagedModelProjectActivityModel: { _embedded?: { activities?: components["schemas"]["ProjectActivityModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; ProjectActivityAuthorModel: { /** Format: int64 */ id: number; username?: string; name?: string; avatar?: components["schemas"]["Avatar"]; deleted: boolean; }; ProjectActivityModel: { /** Format: int64 */ revisionId: number; /** Format: int64 */ timestamp: number; /** @enum {string} */ type: "UNKNOWN" | "SET_TRANSLATION_STATE" | "SET_TRANSLATIONS" | "DISMISS_AUTO_TRANSLATED_STATE" | "SET_OUTDATED_FLAG" | "TRANSLATION_COMMENT_ADD" | "TRANSLATION_COMMENT_DELETE" | "TRANSLATION_COMMENT_EDIT" | "TRANSLATION_COMMENT_SET_STATE" | "SCREENSHOT_DELETE" | "SCREENSHOT_ADD" | "KEY_TAGS_EDIT" | "KEY_NAME_EDIT" | "KEY_DELETE" | "CREATE_KEY" | "COMPLEX_EDIT" | "IMPORT" | "CREATE_LANGUAGE" | "EDIT_LANGUAGE" | "DELETE_LANGUAGE" | "HARD_DELETE_LANGUAGE" | "CREATE_PROJECT" | "EDIT_PROJECT" | "NAMESPACE_EDIT" | "BATCH_PRE_TRANSLATE_BY_TM" | "BATCH_MACHINE_TRANSLATE" | "AUTO_TRANSLATE" | "BATCH_CLEAR_TRANSLATIONS" | "BATCH_COPY_TRANSLATIONS" | "BATCH_SET_TRANSLATION_STATE" | "BATCH_TAG_KEYS" | "BATCH_UNTAG_KEYS" | "BATCH_SET_KEYS_NAMESPACE" | "AUTOMATION" | "CONTENT_DELIVERY_CONFIG_CREATE" | "CONTENT_DELIVERY_CONFIG_UPDATE" | "CONTENT_DELIVERY_CONFIG_DELETE" | "CONTENT_STORAGE_CREATE" | "CONTENT_STORAGE_UPDATE" | "CONTENT_STORAGE_DELETE" | "WEBHOOK_CONFIG_CREATE" | "WEBHOOK_CONFIG_UPDATE" | "WEBHOOK_CONFIG_DELETE" | "COMPLEX_TAG_OPERATION"; author?: components["schemas"]["ProjectActivityAuthorModel"]; modifiedEntities?: { [key: string]: components["schemas"]["ModifiedEntityModel"][]; }; meta?: { [key: string]: Record; }; counts?: { [key: string]: number; }; params?: Record; }; PropertyModification: { old?: Record; new?: Record; }; PagedModelTagModel: { _embedded?: { tags?: components["schemas"]["TagModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; PagedModelBatchJobModel: { _embedded?: { batchJobs?: components["schemas"]["BatchJobModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; CreditBalanceModel: { /** Format: int64 */ creditBalance: number; /** Format: int64 */ bucketSize: number; /** Format: int64 */ extraCreditBalance: number; }; CollectionModelKeyWithBaseTranslationModel: { _embedded?: { keys?: components["schemas"]["KeyWithBaseTranslationModel"][]; }; }; KeyWithBaseTranslationModel: { /** * Format: int64 * @description Id of key record */ id: number; /** * @description Name of key * @example this_is_super_key */ name: string; /** * @description Namespace of key * @example homepage */ namespace?: string; /** * @description Base translation * @example This is translation */ baseTranslation?: string; }; ImportTranslationModel: { /** Format: int64 */ id: number; text?: string; keyName: string; /** Format: int64 */ keyId: number; keyDescription?: string; /** Format: int64 */ conflictId?: number; conflictText?: string; override: boolean; resolved: boolean; isPlural: boolean; existingKeyIsPlural: boolean; }; PagedModelImportTranslationModel: { _embedded?: { translations?: components["schemas"]["ImportTranslationModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; ImportFileIssueModel: { /** Format: int64 */ id: number; /** @enum {string} */ type: "KEY_IS_NOT_STRING" | "MULTIPLE_VALUES_FOR_KEY_AND_LANGUAGE" | "VALUE_IS_NOT_STRING" | "KEY_IS_EMPTY" | "VALUE_IS_EMPTY" | "PO_MSGCTXT_NOT_SUPPORTED" | "ID_ATTRIBUTE_NOT_PROVIDED" | "TARGET_NOT_PROVIDED" | "TRANSLATION_TOO_LONG" | "KEY_IS_BLANK" | "TRANSLATION_DEFINED_IN_ANOTHER_FILE" | "INVALID_CUSTOM_VALUES"; params: components["schemas"]["ImportFileIssueParamModel"][]; }; ImportFileIssueParamModel: { /** @enum {string} */ type: "KEY_NAME" | "KEY_ID" | "LANGUAGE_ID" | "KEY_INDEX" | "VALUE" | "LINE" | "FILE_NODE_ORIGINAL" | "LANGUAGE_NAME"; value?: string; }; PagedModelImportFileIssueModel: { _embedded?: { importFileIssues?: components["schemas"]["ImportFileIssueModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; CollectionModelImportNamespaceModel: { _embedded?: { namespaces?: components["schemas"]["ImportNamespaceModel"][]; }; }; ImportNamespaceModel: { /** * Format: int64 * @description The id of namespace. When null, namespace doesn't exist and will be created by import. * @example 10000048 */ id?: number; /** @example homepage */ name: string; }; CollectionModelBatchJobModel: { _embedded?: { batchJobs?: components["schemas"]["BatchJobModel"][]; }; }; PagedModelTranslationCommentModel: { _embedded?: { translationComments?: components["schemas"]["TranslationCommentModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; PagedModelTranslationHistoryModel: { _embedded?: { revisions?: components["schemas"]["TranslationHistoryModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; TranslationHistoryModel: { /** @description Modified fields */ modifications?: { [key: string]: components["schemas"]["PropertyModification"]; }; /** * Format: int64 * @description Unix timestamp of the revision */ timestamp: number; author?: components["schemas"]["SimpleUserAccountModel"]; /** @enum {string} */ revisionType: "ADD" | "MOD" | "DEL"; }; SelectAllResponse: { ids: number[]; }; KeyWithTranslationsModel: { /** * Format: int64 * @description Id of key record */ keyId: number; /** * @description Name of key * @example this_is_super_key */ keyName: string; /** * @description Is this key a plural? * @example true */ keyIsPlural: boolean; /** * @description The placeholder name for plural parameter * @example value */ keyPluralArgName?: string; /** * Format: int64 * @description The namespace id of the key * @example 100000282 */ keyNamespaceId?: number; /** * @description The namespace of the key * @example homepage */ keyNamespace?: string; /** * @description The namespace of the key * @example homepage */ keyDescription?: string; /** @description Tags of key */ keyTags: components["schemas"]["TagModel"][]; /** * Format: int64 * @description Count of screenshots provided for the key * @example 1 */ screenshotCount: number; /** @description Key screenshots. Not provided when API key hasn't screenshots.view scope permission. */ screenshots?: components["schemas"]["ScreenshotModel"][]; /** @description There is a context available for this key */ contextPresent: boolean; /** * @description Translations object * @example * { * "en": { * "id": 100000003, * "text": "This is super translation!" * "state": "TRANSLATED", * "commentCount": 1 * } * } */ translations: { [key: string]: components["schemas"]["TranslationViewModel"]; }; }; KeysWithTranslationsPageModel: { _embedded?: { keys?: components["schemas"]["KeyWithTranslationsModel"][]; }; page?: components["schemas"]["PageMetadata"]; /** @description Provided languages data */ selectedLanguages: components["schemas"]["LanguageModel"][]; /** * @description Cursor to get next data * @example eyJrZXlJZCI6eyJkaXJlY3Rpb24iOiJBU0MiLCJ2YWx1ZSI6IjEwMDAwMDAxMjAifX0= */ nextCursor?: string; }; /** * @description Translations object * @example * { * "en": { * "id": 100000003, * "text": "This is super translation!" * "state": "TRANSLATED", * "commentCount": 1 * } * } */ TranslationViewModel: { /** * Format: int64 * @description Id of translation record */ id: number; /** @description Translation text */ text?: string; /** * @description State of translation * @enum {string} */ state: "UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED"; /** @description Whether base language translation was changed after this translation was updated */ outdated: boolean; /** @description Was translated using Translation Memory or Machine translation service? */ auto: boolean; /** * @description Which machine translation service was used to auto translate this * @enum {string} */ mtProvider?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; /** * Format: int64 * @description Count of translation comments */ commentCount: number; /** * Format: int64 * @description Count of unresolved translation comments */ unresolvedCommentCount: number; /** @description Was translation memory used to translate this? */ fromTranslationMemory: boolean; }; LanguageStatsModel: { /** Format: int64 */ languageId?: number; languageTag?: string; languageName?: string; languageOriginalName?: string; languageFlagEmoji?: string; /** Format: int64 */ translatedKeyCount: number; /** Format: int64 */ translatedWordCount: number; /** Format: double */ translatedPercentage: number; /** Format: int64 */ reviewedKeyCount: number; /** Format: int64 */ reviewedWordCount: number; /** Format: double */ reviewedPercentage: number; /** Format: int64 */ untranslatedKeyCount: number; /** Format: int64 */ untranslatedWordCount: number; /** Format: double */ untranslatedPercentage: number; }; ProjectStatsModel: { /** Format: int64 */ projectId: number; /** Format: int32 */ languageCount: number; /** Format: int64 */ keyCount: number; /** Format: int64 */ baseWordsCount: number; /** Format: double */ translatedPercentage: number; /** Format: double */ reviewedPercentage: number; /** Format: int64 */ membersCount: number; /** Format: int64 */ tagCount: number; languageStats: components["schemas"]["LanguageStatsModel"][]; }; PagedModelLanguageModel: { _embedded?: { languages?: components["schemas"]["LanguageModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; CollectionModelScreenshotModel: { _embedded?: { screenshots?: components["schemas"]["ScreenshotModel"][]; }; }; PatWithUserModel: { user: components["schemas"]["SimpleUserAccountModel"]; /** Format: int64 */ id: number; /** Format: int64 */ expiresAt?: number; /** Format: int64 */ lastUsedAt?: number; description: string; /** Format: int64 */ createdAt: number; /** Format: int64 */ updatedAt: number; }; PagedModelOrganizationModel: { _embedded?: { organizations?: components["schemas"]["OrganizationModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; SimpleProjectModel: { /** Format: int64 */ id: number; name: string; description?: string; slug?: string; avatar?: components["schemas"]["Avatar"]; baseLanguage?: components["schemas"]["LanguageModel"]; icuPlaceholders: boolean; }; ApiKeyWithLanguagesModel: { /** * @deprecated * @description Languages for which user has translate permission. */ permittedLanguageIds?: number[]; /** Format: int64 */ id: number; projectName: string; userFullName?: string; scopes: string[]; /** Format: int64 */ expiresAt?: number; /** Format: int64 */ projectId: number; /** Format: int64 */ lastUsedAt?: number; username?: string; description: string; }; ApiKeyPermissionsModel: { /** * Format: int64 * @description The API key's project id or the one provided as query param */ projectId: number; /** * @description List of languages user can view. If null, all languages view is permitted. * @example [ * 200001, * 200004 * ] */ viewLanguageIds?: number[]; /** * @description List of languages user can translate to. If null, all languages editing is permitted. * @example [ * 200001, * 200004 * ] */ translateLanguageIds?: number[]; /** * @description List of languages user can change state to. If null, changing state of all language values is permitted. * @example [ * 200001, * 200004 * ] */ stateChangeLanguageIds?: number[]; /** * @description Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type. * @example [ * "KEYS_EDIT", * "TRANSLATIONS_VIEW" * ] */ scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage")[]; /** * @description The user's permission type. This field is null if user has assigned granular permissions or if returning API key's permissions * @enum {string} */ type?: "NONE" | "VIEW" | "TRANSLATE" | "REVIEW" | "EDIT" | "MANAGE"; project: components["schemas"]["SimpleProjectModel"]; }; DeleteKeysDto: { /** @description IDs of keys to delete */ ids: number[]; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export type external = Record; export interface operations { /** * Get user info * @description Returns information about currently authenticated user. */ getInfo_2: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PrivateUserAccountModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Update namespace */ update_2: { parameters: { path: { id: number; }; }; requestBody: { content: { "application/json": components["schemas"]["UpdateNamespaceDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["NamespaceModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get disabled languages * @description Returns languages, in which key is disabled */ getDisabledLanguages_1: { parameters: { path: { id: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelLanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Set disabled languages * @description Sets languages, in which key is disabled */ setDisabledLanguages_1: { parameters: { path: { id: number; }; }; requestBody: { content: { "application/json": components["schemas"]["SetDisabledLanguagesRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelLanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Edit key and related data * @description Edits key name, translations, tags, screenshots, and other data */ complexEdit_1: { parameters: { path: { id: number; }; }; requestBody: { content: { "application/json": components["schemas"]["ComplexEditKeyDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["KeyWithDataModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get one key */ get_7: { parameters: { path: { id: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["KeyModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Edit key name */ edit_1: { parameters: { path: { id: number; }; }; requestBody: { content: { "application/json": components["schemas"]["EditKeyDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["KeyModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Execute complex tag operation */ executeComplexTagOperation_1: { requestBody: { content: { "application/json": components["schemas"]["ComplexTagKeysRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Tag key * @description Tags a key with tag. If tag with provided name doesn't exist, it is created */ tagKey_1: { parameters: { path: { keyId: number; }; }; requestBody: { content: { "application/json": components["schemas"]["TagKeyDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TagModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Resolve conflict (override) * @description Resolves translation conflict. The old translation will be overridden. */ resolveTranslationSetOverride_1: { parameters: { path: { languageId: number; translationId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Resolve conflict (keep existing) * @description Resolves translation conflict. The old translation will be kept. */ resolveTranslationSetKeepExisting_1: { parameters: { path: { languageId: number; translationId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Resolve all translation conflicts (override) * @description Resolves all translation conflicts for provided language. The old translations will be overridden. */ resolveTranslationSetOverride_3: { parameters: { path: { languageId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Resolve all translation conflicts (keep existing) * @description Resolves all translation conflicts for provided language. The old translations will be kept. */ resolveTranslationSetKeepExisting_3: { parameters: { path: { languageId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Pair existing language * @description Sets existing language to pair with language to import. Data will be imported to selected existing language when applied. */ selectExistingLanguage_1: { parameters: { path: { importLanguageId: number; existingLanguageId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Reset existing language pairing * @description Resets existing language paired with language to import. */ resetExistingLanguage_1: { parameters: { path: { importLanguageId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Select namespace * @description Sets namespace for file to import. */ selectNamespace_1: { parameters: { path: { fileId: number; }; }; requestBody: { content: { "application/json": components["schemas"]["SetFileNamespaceRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Apply import (streaming) * @description Imports the data prepared in previous step. Streams current status. */ applyImportStreaming_1: { parameters: { query?: { /** @description Whether override or keep all translations with unresolved conflicts */ forceMode?: "OVERRIDE" | "KEEP" | "NO_FORCE"; }; }; responses: { /** @description OK */ 200: { content: { "application/x-ndjson": components["schemas"]["StreamingResponseBody"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Apply import * @description Imports the data prepared in previous step */ applyImport_1: { parameters: { query?: { /** @description Whether override or keep all translations with unresolved conflicts */ forceMode?: "OVERRIDE" | "KEEP" | "NO_FORCE"; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get Import Settings * @description Returns import settings for the authenticated user and the project. */ get_11: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ImportSettingsModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Set Import Settings * @description Stores import settings for the authenticated user and the project. */ store_1: { requestBody: { content: { "application/json": components["schemas"]["ImportSettingsRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ImportSettingsModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Stop batch operation * @description Stops batch operation if possible. */ cancel_1: { parameters: { path: { id: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Set translation state */ setTranslationState_1: { parameters: { path: { translationId: number; state: "TRANSLATED" | "REVIEWED"; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TranslationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Set state of translation comment */ setState_1: { parameters: { path: { translationId: number; commentId: number; state: "RESOLUTION_NOT_NEEDED" | "NEEDS_RESOLUTION" | "RESOLVED"; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TranslationCommentModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get one translation comment */ get_15: { parameters: { path: { translationId: number; commentId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TranslationCommentModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Update translation comment */ update_6: { parameters: { path: { commentId: number; translationId: number; }; }; requestBody: { content: { "application/json": components["schemas"]["TranslationCommentDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TranslationCommentModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Delete translation comment */ delete_9: { parameters: { path: { translationId: number; commentId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Set outdated value * @description Set's "outdated" flag indicating the base translation was changed without updating current translation. */ setOutdated_1: { parameters: { path: { translationId: number; state: boolean; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TranslationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Dismiss auto-translated * @description Removes "auto translated" indication */ dismissAutoTranslatedState_1: { parameters: { path: { translationId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TranslationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get translations in project */ getTranslations_1: { parameters: { query?: { /** @description Cursor to get next data */ cursor?: string; /** * @description Translation state in the format: languageTag,state. You can use this parameter multiple times. * * When used with multiple states for same language it is applied with logical OR. * * When used with multiple languages, it is applied with logical AND. */ filterState?: string[]; /** * @description Languages to be contained in response. * * To add multiple languages, repeat this param (eg. ?languages=en&languages=de) * @example en */ languages?: string[]; /** @description String to search in key name or translation text */ search?: string; /** @description Selects key with provided names. Use this param multiple times to fetch more keys. */ filterKeyName?: string[]; /** @description Selects key with provided ID. Use this param multiple times to fetch more keys. */ filterKeyId?: number[]; /** @description Selects only keys for which the translation is missing in any returned language. It only filters for translations included in returned languages. */ filterUntranslatedAny?: boolean; /** @description Selects only keys, where translation is provided in any language */ filterTranslatedAny?: boolean; /** * @description Selects only keys where the translation is missing for the specified language. The specified language must be included in the returned languages. Otherwise, this filter doesn't apply. * @example en-US */ filterUntranslatedInLang?: string; /** * @description Selects only keys, where translation is provided in specified language * @example en-US */ filterTranslatedInLang?: string; /** @description Selects only keys with screenshots */ filterHasScreenshot?: boolean; /** @description Selects only keys without screenshots */ filterHasNoScreenshot?: boolean; /** * @description Filter namespaces. * * To filter default namespace, set to empty string. */ filterNamespace?: string[]; /** @description Selects only keys with provided tag */ filterTag?: string[]; /** * @description Selects only keys, where translation in provided langs is in outdated state * @example en-US */ filterOutdatedLanguage?: string[]; /** * @description Selects only keys, where translation in provided langs is not in outdated state * @example en-US */ filterNotOutdatedLanguage?: string[]; /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["KeysWithTranslationsPageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Update translations for existing key * @description Sets translations for existing key */ setTranslations_1: { requestBody: { content: { "application/json": components["schemas"]["SetTranslationsWithKeyDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SetTranslationsResponseModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Create key or update translations * @description Sets translations for existing key or creates new key and sets the translations to it. */ createOrUpdateTranslations_1: { requestBody: { content: { "application/json": components["schemas"]["SetTranslationsWithKeyDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SetTranslationsResponseModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get one language */ get_17: { parameters: { path: { languageId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["LanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Update language */ editLanguage_1: { parameters: { path: { languageId: number; }; }; requestBody: { content: { "application/json": components["schemas"]["LanguageRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["LanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Delete specific language */ deleteLanguage_3: { parameters: { path: { languageId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Auto translates keys * @description Uses enabled auto-translation methods. * You need to set at least one of useMachineTranslation or useTranslationMemory to true. * * This will replace the the existing translation with the result obtained from specified source! */ autoTranslate_1: { parameters: { query?: { /** * @description Tags of languages to auto-translate. * When no languages provided, it translates only untranslated languages. */ languages?: string[]; useMachineTranslation?: boolean; useTranslationMemory?: boolean; }; path: { keyId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get one organization */ get_20: { parameters: { path: { id: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OrganizationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get all permitted * @description Returns all projects where current user has any permission */ getAll: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; search?: string; }; }; responses: { /** @description OK */ 200: { content: { "application/hal+json": components["schemas"]["PagedModelProjectModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Create project * @description Creates a new project with languages and initial settings. */ createProject: { requestBody: { content: { "application/json": components["schemas"]["CreateProjectRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get key info * @description Returns information about keys. (KeyData, Screenshots, Translation in specified language)If key is not found, it's not included in the response. */ getInfo_1: { requestBody: { content: { "application/json": components["schemas"]["GetKeysRequestDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelKeyWithDataModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Import keys (resolvable) * @description Import's new keys with translations. Translations can be updated, when specified. */ importKeys_1: { requestBody: { content: { "application/json": components["schemas"]["ImportKeysResolvableDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["KeyImportResolvableResultModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Import keys * @description Imports new keys with translations. If key already exists, its translations and tags are not updated. */ importKeys_3: { requestBody: { content: { "application/json": components["schemas"]["ImportKeysDto"]; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Create new key */ create_3: { requestBody: { content: { "application/json": components["schemas"]["CreateKeyDto"]; }; }; responses: { /** @description Created */ 201: { content: { "*/*": components["schemas"]["KeyWithDataModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get all keys */ getAll_2: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelKeyModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Create new key */ create_4: { requestBody: { content: { "application/json": components["schemas"]["CreateKeyDto"]; }; }; responses: { /** @description Created */ 201: { content: { "*/*": components["schemas"]["KeyWithDataModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Delete one or multiple keys (post) * @description Delete one or multiple keys by their IDs in request body. Useful for larger requests esxceeding allowed URL length. */ delete_5: { requestBody: { content: { "application/json": components["schemas"]["DeleteKeysDto"]; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Remove tags */ untagKeys_1: { requestBody: { content: { "application/json": components["schemas"]["UntagKeysRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Add tags */ tagKeys_1: { requestBody: { content: { "application/json": components["schemas"]["TagKeysRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Set translation state */ setTranslationState_3: { requestBody: { content: { "application/json": components["schemas"]["SetTranslationsStateStateRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Set keys namespace */ setKeysNamespace_1: { requestBody: { content: { "application/json": components["schemas"]["SetKeysNamespaceRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Pre-translate by TM * @description Pre-translate provided keys to provided languages by TM. */ translate_1: { requestBody: { content: { "application/json": components["schemas"]["PreTranslationByTmRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Machine Translation * @description Translate provided keys to provided languages through primary MT provider. */ machineTranslation_1: { requestBody: { content: { "application/json": components["schemas"]["MachineTranslationRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Delete keys */ deleteKeys_1: { requestBody: { content: { "application/json": components["schemas"]["DeleteKeysRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Copy translation values * @description Copy translation values from one language to other languages. */ copyTranslations_1: { requestBody: { content: { "application/json": components["schemas"]["CopyTranslationRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Clear translation values * @description Clear translation values for provided keys in selected languages. */ clearTranslations_1: { requestBody: { content: { "application/json": components["schemas"]["ClearTranslationsRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Single step import * @description Unlike the /v2/projects/{projectId}/import endpoint, imports the data in single request by provided files and parameters. This is useful for automated importing via API or CLI. */ doImport_1: { requestBody?: { content: { "multipart/form-data": { files: string[]; params: components["schemas"]["SingleStepImportRequest"]; }; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Add files * @description Prepares provided files to import. */ addFiles_1: { parameters: { query?: { /** * @description When importing files in structured formats (e.g., JSON, YAML), this field defines the delimiter which will be used in names of imported keys. * @example . */ structureDelimiter?: string; }; }; requestBody?: { content: { "multipart/form-data": { files: string[]; }; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ImportAddFilesResultModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Delete * @description Deletes prepared import data. */ cancelImport_1: { responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Export data */ export_1: { parameters: { query?: { /** * @description Languages to be contained in export. * * If null, all languages are exported * @example en */ languages?: string[]; /** @description Format to export to */ format?: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML"; /** * @description Delimiter to structure file content. * * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. * * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), * specific formats like `YAML_RUBY` don't honor this parameter. */ structureDelimiter?: string; /** @description Filter key IDs to be contained in export */ filterKeyId?: number[]; /** @description Filter key IDs not to be contained in export */ filterKeyIdNot?: number[]; /** * @description Filter keys tagged by. * * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ filterTag?: string; /** @description Filter keys tagged by one of provided tags */ filterTagIn?: string[]; /** @description Filter keys not tagged by one of provided tags */ filterTagNotIn?: string[]; /** @description Filter keys with prefix */ filterKeyPrefix?: string; /** @description Filter translations with state. By default, all states except untranslated is exported. */ filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ filterNamespace?: string[]; /** * @description If false, it doesn't return zip of files, but it returns single file. * * This is possible only when single language is exported. Otherwise it returns "400 - Bad Request" response. */ zip?: boolean; /** * @description Message format to be used for export. * * e.g. PHP_PO: Hello %s, ICU: Hello {name}. * * This property is honored only for generic formats like JSON or YAML. * For specific formats like `YAML_RUBY` it's ignored. */ messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "ICU"; /** * @description This is a template that defines the structure of the resulting .zip file content. * * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, * {androidLanguageTag}, {snakeLanguageTag}, {extension}. * * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, * the English translations of the `home` namespace will be stored in `home/en.json`. * * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). * * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` * but in Android format. (e.g., en-rUS) */ fileStructureTemplate?: string; /** * @description If true, for structured formats (like JSON) arrays are supported. * * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ supportArrays?: boolean; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StreamingResponseBody"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Export data (post) * @description Exports data (post). Useful when exceeding allowed URL size. */ exportPost_1: { requestBody: { content: { "application/json": components["schemas"]["ExportParams"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StreamingResponseBody"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Store Big Meta * @description Stores a bigMeta for a project */ store_3: { requestBody: { content: { "application/json": components["schemas"]["BigMetaDto"]; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get translation comments * @description Returns translation comments of translation */ getAll_6: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; path: { translationId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelTranslationCommentModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Create translation comment */ create_8: { parameters: { path: { translationId: number; }; }; requestBody: { content: { "application/json": components["schemas"]["TranslationCommentDto"]; }; }; responses: { /** @description Created */ 201: { content: { "*/*": components["schemas"]["TranslationCommentModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Create translation comment * @description Creates a translation comment. Empty translation is stored, when not exists. */ create_10: { requestBody: { content: { "application/json": components["schemas"]["TranslationCommentWithLangKeyDto"]; }; }; responses: { /** @description Created */ 201: { content: { "*/*": components["schemas"]["TranslationWithCommentModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get suggestions from translation memory * @description Suggests machine translations from translation memory. The result is always sorted by similarity, so sorting is not supported. */ suggestTranslationMemory_1: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; requestBody: { content: { "application/json": components["schemas"]["SuggestRequestDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelTranslationMemoryItemModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get machine translation suggestions (streaming) * @description Suggests machine translations from enabled services. The results are streamed to the output in ndjson format. If an error occurs when for any service provider used, the error information is returned as a part of the result item, while the response has 200 status code. */ suggestMachineTranslationsStreaming_1: { requestBody: { content: { "application/json": components["schemas"]["SuggestRequestDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/x-ndjson": components["schemas"]["StreamingResponseBody"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get machine translation suggestions * @description Suggests machine translations from enabled services */ suggestMachineTranslations_1: { requestBody: { content: { "application/json": components["schemas"]["SuggestRequestDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SuggestResultModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get all languages */ getAll_8: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelLanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Create language */ createLanguage_1: { requestBody: { content: { "application/json": components["schemas"]["LanguageRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["LanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get screenshots */ getKeyScreenshots: { parameters: { path: { keyId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelScreenshotModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Upload screenshot */ uploadScreenshot: { parameters: { path: { keyId: number; }; }; requestBody?: { content: { "multipart/form-data": { /** Format: binary */ screenshot: string; info?: components["schemas"]["ScreenshotInfoDto"]; }; }; }; responses: { /** @description Created */ 201: { content: { "*/*": components["schemas"]["ScreenshotModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get all permitted organizations * @description Returns all organizations, which is current user allowed to view */ getAll_10: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; filterCurrentUserOwner?: boolean; search?: string; }; }; responses: { /** @description OK */ 200: { content: { "application/hal+json": components["schemas"]["PagedModelOrganizationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Create organization */ create_12: { requestBody: { content: { "application/json": components["schemas"]["OrganizationDto"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OrganizationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Upload an image for later use */ upload: { requestBody?: { content: { "multipart/form-data": { /** Format: binary */ image: string; info?: components["schemas"]["ImageUploadInfoDto"]; }; }; }; responses: { /** @description Created */ 201: { content: { "*/*": components["schemas"]["UploadedImageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get used namespaces * @description Returns all used project namespaces. Response contains default (null) namespace if used. */ getUsedNamespaces_1: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelUsedNamespaceModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get namespaces */ getAllNamespaces_1: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelNamespaceModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get namespace by name * @description Returns information about a namespace by its name */ getByName_1: { parameters: { path: { name: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["NamespaceModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Search for keys * @description This endpoint helps you to find desired key by keyName, base translation or translation in specified language. */ searchForKey_1: { parameters: { query: { /** @description Search query */ search: string; /** @description Language to search in */ languageTag?: string; /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelKeySearchSearchResultModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get project activity */ getActivity_1: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/hal+json": components["schemas"]["PagedModelProjectActivityModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get tags */ getAll_4: { parameters: { query?: { search?: string; /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelTagModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * List user batch operations * @description List all batch operations started by current user */ myList_1: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelBatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get Big Meta for key */ getBigMeta_1: { parameters: { path: { id: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelKeyWithBaseTranslationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get translations * @description Returns translations prepared to import. */ getImportTranslations_1: { parameters: { query?: { /** @description Whether only translations, which are in conflict with existing translations should be returned */ onlyConflicts?: boolean; /** @description Whether only translations with unresolved conflictswith existing translations should be returned */ onlyUnresolved?: boolean; /** @description String to search in translation text or key */ search?: string; /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; path: { languageId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelImportTranslationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get import language * @description Returns language prepared to import. */ getImportLanguage_1: { parameters: { path: { languageId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ImportLanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Delete language * @description Deletes language prepared to import. */ deleteLanguage_1: { parameters: { path: { languageId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get file issues * @description Returns issues for uploaded file. */ getImportFileIssues_1: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; path: { importFileId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelImportFileIssueModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get result * @description Returns the result of preparation. */ getImportResult_1: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelImportLanguageModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get namespaces * @description Returns all existing and imported namespaces */ getAllNamespaces_3: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelImportNamespaceModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get all running and pending batch operations * @description Returns all running and pending batch operations. Completed batch operations are returned only if they are not older than 1 hour. If user doesn't have permission to view all batch operations, only their operations are returned. */ currentJobs_1: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollectionModelBatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get batch operation */ get_13: { parameters: { path: { id: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** List batch operations */ list_4: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelBatchJobModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get translation history * @description Sorting is not supported for supported. It is automatically sorted from newest to oldest. */ getTranslationHistory_1: { parameters: { query?: { /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; }; path: { translationId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PagedModelTranslationHistoryModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get all translations * @description Returns all translations for specified languages */ getAllTranslations_1: { parameters: { query?: { /** @description Namespace to return */ ns?: string; /** * @description Delimiter to structure response content. * * e.g. For key "home.header.title" would result in {"home": {"header": {"title": "Hello"}}} structure. * * When null, resulting file will be a flat key-value object. */ structureDelimiter?: string; }; path: { /** * @description Comma-separated language tags to return translations in. Languages you are not permitted to see will be silently dropped and not returned. * @example en,de,fr */ languages: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": string; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Select keys * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. */ selectKeys_1: { parameters: { query?: { /** * @description Translation state in the format: languageTag,state. You can use this parameter multiple times. * * When used with multiple states for same language it is applied with logical OR. * * When used with multiple languages, it is applied with logical AND. */ filterState?: string[]; /** * @description Languages to be contained in response. * * To add multiple languages, repeat this param (eg. ?languages=en&languages=de) * @example en */ languages?: string[]; /** @description String to search in key name or translation text */ search?: string; /** @description Selects key with provided names. Use this param multiple times to fetch more keys. */ filterKeyName?: string[]; /** @description Selects key with provided ID. Use this param multiple times to fetch more keys. */ filterKeyId?: number[]; /** @description Selects only keys for which the translation is missing in any returned language. It only filters for translations included in returned languages. */ filterUntranslatedAny?: boolean; /** @description Selects only keys, where translation is provided in any language */ filterTranslatedAny?: boolean; /** * @description Selects only keys where the translation is missing for the specified language. The specified language must be included in the returned languages. Otherwise, this filter doesn't apply. * @example en-US */ filterUntranslatedInLang?: string; /** * @description Selects only keys, where translation is provided in specified language * @example en-US */ filterTranslatedInLang?: string; /** @description Selects only keys with screenshots */ filterHasScreenshot?: boolean; /** @description Selects only keys without screenshots */ filterHasNoScreenshot?: boolean; /** * @description Filter namespaces. * * To filter default namespace, set to empty string. */ filterNamespace?: string[]; /** @description Selects only keys with provided tag */ filterTag?: string[]; /** * @description Selects only keys, where translation in provided langs is in outdated state * @example en-US */ filterOutdatedLanguage?: string[]; /** * @description Selects only keys, where translation in provided langs is not in outdated state * @example en-US */ filterNotOutdatedLanguage?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SelectAllResponse"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Select keys * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. */ selectKeys_3: { parameters: { query?: { /** * @description Translation state in the format: languageTag,state. You can use this parameter multiple times. * * When used with multiple states for same language it is applied with logical OR. * * When used with multiple languages, it is applied with logical AND. */ filterState?: string[]; /** * @description Languages to be contained in response. * * To add multiple languages, repeat this param (eg. ?languages=en&languages=de) * @example en */ languages?: string[]; /** @description String to search in key name or translation text */ search?: string; /** @description Selects key with provided names. Use this param multiple times to fetch more keys. */ filterKeyName?: string[]; /** @description Selects key with provided ID. Use this param multiple times to fetch more keys. */ filterKeyId?: number[]; /** @description Selects only keys for which the translation is missing in any returned language. It only filters for translations included in returned languages. */ filterUntranslatedAny?: boolean; /** @description Selects only keys, where translation is provided in any language */ filterTranslatedAny?: boolean; /** * @description Selects only keys where the translation is missing for the specified language. The specified language must be included in the returned languages. Otherwise, this filter doesn't apply. * @example en-US */ filterUntranslatedInLang?: string; /** * @description Selects only keys, where translation is provided in specified language * @example en-US */ filterTranslatedInLang?: string; /** @description Selects only keys with screenshots */ filterHasScreenshot?: boolean; /** @description Selects only keys without screenshots */ filterHasNoScreenshot?: boolean; /** * @description Filter namespaces. * * To filter default namespace, set to empty string. */ filterNamespace?: string[]; /** @description Selects only keys with provided tag */ filterTag?: string[]; /** * @description Selects only keys, where translation in provided langs is in outdated state * @example en-US */ filterOutdatedLanguage?: string[]; /** * @description Selects only keys, where translation in provided langs is not in outdated state * @example en-US */ filterNotOutdatedLanguage?: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SelectAllResponse"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get project daily amount of events */ getProjectDailyActivity_1: { responses: { /** @description OK */ 200: { content: { "application/hal+json": { [key: string]: number; }; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get project stats */ getProjectStats_1: { responses: { /** @description OK */ 200: { content: { "application/hal+json": components["schemas"]["ProjectStatsModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Return current PAK * @description Returns current Personal Access Token. If the request is not authenticated with a Personal Access Token, it will return 400 response status. */ getCurrent: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PatWithUserModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Get organization by slug */ get_19: { parameters: { path: { slug: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OrganizationModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get credit balance for organization * @description Returns machine translation credit balance for organization */ getOrganizationCredits: { parameters: { path: { organizationId: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CreditBalanceModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get current API key info * @description Returns info the API key which user currently authenticated with. Otherwise responds with 400 status code. */ getCurrent_1: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ApiKeyWithLanguagesModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Get current permission info * @description Returns current PAK or PAT permissions for current user, api-key and project */ getCurrentPermissions: { parameters: { query?: { /** @description Required when using with PAT */ projectId?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ApiKeyPermissionsModel"]; }; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Delete one or multiple keys */ delete_3: { parameters: { path: { ids: number[]; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** * Remove tag * @description Removes tag with provided id from key with provided id */ removeTag_1: { parameters: { path: { keyId: number; tagId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Delete screenshots */ deleteScreenshots: { parameters: { path: { ids: number[]; keyId: number; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; /** Delete uploaded images */ delete_12: { parameters: { path: { ids: number[]; }; }; responses: { /** @description OK */ 200: { content: never; }; /** @description Bad Request */ 400: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Unauthorized */ 401: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; }; }; }