Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 37 additions & 9 deletions crowdin_api/api_resources/translations/resource.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from crowdin_api.api_resources.translations.types import (
FallbackLanguages,
EditPreTranslationScheme,
UploadTranslationRequest,
)
from crowdin_api.api_resources.translations.enums import (
CharTransformation,
Expand Down Expand Up @@ -325,26 +326,53 @@ def upload_translation(
importEqSuggestions: Optional[bool] = None,
autoApproveImported: Optional[bool] = None,
translateHidden: Optional[bool] = None,
):
addToTm: Optional[bool] = None,
) -> dict:
"""
Upload Translations.

Parameters
----------
languageId: str
Language ID.
storageId: int
Storage ID.
fileId: int
File ID for import.
projectId: Optional[int]
Project ID.
importEqSuggestions: Optional[bool]
Define whether to add equal translations.
autoApproveImported: Optional[bool]
Mark uploaded translations as approved.
translateHidden: Optional[bool]
Allow translations upload to hidden source strings.
addToTm: Optional[bool]
Define whether to add translation to TM. Default: true

Returns
-------
dict
Upload Translation response from the API

Link to documentation:
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.postOnLanguage
"""

projectId = projectId or self.get_project_id()

request_data: UploadTranslationRequest = {
"storageId": storageId,
"fileId": fileId,
"importEqSuggestions": importEqSuggestions,
"autoApproveImported": autoApproveImported,
"translateHidden": translateHidden,
"addToTm": addToTm,
}

return self.requester.request(
method="post",
path=f"projects/{projectId}/translations/{languageId}",
request_data={
"storageId": storageId,
"fileId": fileId,
"importEqSuggestions": importEqSuggestions,
"autoApproveImported": autoApproveImported,
"translateHidden": translateHidden,
},
request_data=request_data,
)

def download_project_translations(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,7 @@ def test_build_pseudo_project_translation(
"importEqSuggestions": None,
"autoApproveImported": None,
"translateHidden": None,
"addToTm": None,
},
),
(
Expand All @@ -331,13 +332,63 @@ def test_build_pseudo_project_translation(
"importEqSuggestions": False,
"autoApproveImported": False,
"translateHidden": False,
"addToTm": False,
},
{
"storageId": 1,
"fileId": 2,
"importEqSuggestions": False,
"autoApproveImported": False,
"translateHidden": False,
"addToTm": False,
},
),
(
{
"storageId": 1,
"fileId": 2,
"importEqSuggestions": True,
"autoApproveImported": True,
"translateHidden": True,
"addToTm": True,
},
{
"storageId": 1,
"fileId": 2,
"importEqSuggestions": True,
"autoApproveImported": True,
"translateHidden": True,
"addToTm": True,
},
),
(
{
"storageId": 1,
"fileId": 2,
"addToTm": False,
},
{
"storageId": 1,
"fileId": 2,
"importEqSuggestions": None,
"autoApproveImported": None,
"translateHidden": None,
"addToTm": False,
},
),
(
{
"storageId": 1,
"fileId": 2,
"addToTm": True,
},
{
"storageId": 1,
"fileId": 2,
"importEqSuggestions": None,
"autoApproveImported": None,
"translateHidden": None,
"addToTm": True,
},
),
),
Expand Down
13 changes: 10 additions & 3 deletions crowdin_api/api_resources/translations/types.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
from typing import Iterable

from typing import Iterable, Optional
from crowdin_api.typing import TypedDict

from crowdin_api.api_resources.translations.enums import PreTranslationEditOperation


Expand All @@ -13,3 +11,12 @@ class EditPreTranslationScheme(TypedDict):
op: PreTranslationEditOperation
path: str
value: str


class UploadTranslationRequest(TypedDict):
storageId: int
fileId: int
importEqSuggestions: Optional[bool]
autoApproveImported: Optional[bool]
translateHidden: Optional[bool]
addToTm: Optional[bool]