Skip to content

feat: add addToTm parameter support for Upload Translation API #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 4 commits into from
Nov 27, 2024
Merged

feat: add addToTm parameter support for Upload Translation API #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad1099e
feat: add addToTm parameter support for Upload Translation API
imprvhub Nov 27, 2024
65e9a3a
fix: correct indentation in translation resources files
imprvhub Nov 27, 2024
ea3fd6d
fix: flake8 style corrections.
imprvhub Nov 27, 2024
2e1da24
fix: remove unnecessary documentation and return type annotation
imprvhub Nov 27, 2024
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
20 changes: 12 additions & 8 deletions crowdin_api/api_resources/translations/resource.py
View file
Open in desktop
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,29 @@ def upload_translation(
importEqSuggestions: Optional[bool] = None,
autoApproveImported: Optional[bool] = None,
translateHidden: Optional[bool] = None,
addToTm: Optional[bool] = None,
):
"""
Upload Translations.

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
51 changes: 51 additions & 0 deletions crowdin_api/api_resources/translations/tests/test_translations_resources.py
View file
Open in desktop
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
View file
Open in desktop
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]