Skip to content

Commit 0704b4f

Browse files
author
Phrase
committed
1 parent 8bbde33 commit 0704b4f

18 files changed

+846
-5
lines changed

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@ docs/TranslationKeyDetails.md
239239
docs/TranslationOrder.md
240240
docs/TranslationParent.md
241241
docs/TranslationReviewParameters.md
242+
docs/TranslationUnreviewParameters.md
242243
docs/TranslationUnverifyParameters.md
243244
docs/TranslationUpdateParameters.md
244245
docs/TranslationVerifyParameters.md
@@ -249,6 +250,7 @@ docs/TranslationsExcludeParameters.md
249250
docs/TranslationsIncludeParameters.md
250251
docs/TranslationsReviewParameters.md
251252
docs/TranslationsSearchParameters.md
253+
docs/TranslationsUnreviewParameters.md
252254
docs/TranslationsUnverifyParameters.md
253255
docs/TranslationsVerifyParameters.md
254256
docs/Upload.md
@@ -518,6 +520,7 @@ phrase_api/models/translation_key_details.py
518520
phrase_api/models/translation_order.py
519521
phrase_api/models/translation_parent.py
520522
phrase_api/models/translation_review_parameters.py
523+
phrase_api/models/translation_unreview_parameters.py
521524
phrase_api/models/translation_unverify_parameters.py
522525
phrase_api/models/translation_update_parameters.py
523526
phrase_api/models/translation_verify_parameters.py
@@ -527,6 +530,7 @@ phrase_api/models/translations_exclude_parameters.py
527530
phrase_api/models/translations_include_parameters.py
528531
phrase_api/models/translations_review_parameters.py
529532
phrase_api/models/translations_search_parameters.py
533+
phrase_api/models/translations_unreview_parameters.py
530534
phrase_api/models/translations_unverify_parameters.py
531535
phrase_api/models/translations_verify_parameters.py
532536
phrase_api/models/upload.py
@@ -782,6 +786,7 @@ test/test_translation_key_details.py
782786
test/test_translation_order.py
783787
test/test_translation_parent.py
784788
test/test_translation_review_parameters.py
789+
test/test_translation_unreview_parameters.py
785790
test/test_translation_unverify_parameters.py
786791
test/test_translation_update_parameters.py
787792
test/test_translation_verify_parameters.py
@@ -792,6 +797,7 @@ test/test_translations_exclude_parameters.py
792797
test/test_translations_include_parameters.py
793798
test/test_translations_review_parameters.py
794799
test/test_translations_search_parameters.py
800+
test/test_translations_unreview_parameters.py
795801
test/test_translations_unverify_parameters.py
796802
test/test_translations_verify_parameters.py
797803
test/test_upload.py

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,7 @@ Class | Method | HTTP request | Description
380380
*TranslationsApi* | [**translation_include**](docs/TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
381381
*TranslationsApi* | [**translation_review**](docs/TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
382382
*TranslationsApi* | [**translation_show**](docs/TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
383+
*TranslationsApi* | [**translation_unreview**](docs/TranslationsApi.md#translation_unreview) | **PATCH** /projects/{project_id}/translations/{id}/unreview | Unreview a translation
383384
*TranslationsApi* | [**translation_unverify**](docs/TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
384385
*TranslationsApi* | [**translation_update**](docs/TranslationsApi.md#translation_update) | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
385386
*TranslationsApi* | [**translation_verify**](docs/TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
@@ -390,6 +391,7 @@ Class | Method | HTTP request | Description
390391
*TranslationsApi* | [**translations_list**](docs/TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
391392
*TranslationsApi* | [**translations_review_collection**](docs/TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
392393
*TranslationsApi* | [**translations_search**](docs/TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
394+
*TranslationsApi* | [**translations_unreview_collection**](docs/TranslationsApi.md#translations_unreview_collection) | **PATCH** /projects/{project_id}/translations/unreview | Unreview translations selected by query
393395
*TranslationsApi* | [**translations_unverify_collection**](docs/TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
394396
*TranslationsApi* | [**translations_verify_collection**](docs/TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
395397
*UploadsApi* | [**upload_create**](docs/UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
@@ -604,6 +606,7 @@ Class | Method | HTTP request | Description
604606
- [TranslationOrder](docs/TranslationOrder.md)
605607
- [TranslationParent](docs/TranslationParent.md)
606608
- [TranslationReviewParameters](docs/TranslationReviewParameters.md)
609+
- [TranslationUnreviewParameters](docs/TranslationUnreviewParameters.md)
607610
- [TranslationUnverifyParameters](docs/TranslationUnverifyParameters.md)
608611
- [TranslationUpdateParameters](docs/TranslationUpdateParameters.md)
609612
- [TranslationVerifyParameters](docs/TranslationVerifyParameters.md)
@@ -613,6 +616,7 @@ Class | Method | HTTP request | Description
613616
- [TranslationsIncludeParameters](docs/TranslationsIncludeParameters.md)
614617
- [TranslationsReviewParameters](docs/TranslationsReviewParameters.md)
615618
- [TranslationsSearchParameters](docs/TranslationsSearchParameters.md)
619+
- [TranslationsUnreviewParameters](docs/TranslationsUnreviewParameters.md)
616620
- [TranslationsUnverifyParameters](docs/TranslationsUnverifyParameters.md)
617621
- [TranslationsVerifyParameters](docs/TranslationsVerifyParameters.md)
618622
- [Upload](docs/Upload.md)

‎docs/TranslationUnreviewParameters.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# TranslationUnreviewParameters
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**branch** | **str** | specify the branch to use | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/TranslationsApi.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Method | HTTP request | Description
99
[**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
1010
[**translation_review**](TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
1111
[**translation_show**](TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
12+
[**translation_unreview**](TranslationsApi.md#translation_unreview) | **PATCH** /projects/{project_id}/translations/{id}/unreview | Unreview a translation
1213
[**translation_unverify**](TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
1314
[**translation_update**](TranslationsApi.md#translation_update) | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
1415
[**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
@@ -19,6 +20,7 @@ Method | HTTP request | Description
1920
[**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
2021
[**translations_review_collection**](TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
2122
[**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
23+
[**translations_unreview_collection**](TranslationsApi.md#translations_unreview_collection) | **PATCH** /projects/{project_id}/translations/unreview | Unreview translations selected by query
2224
[**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
2325
[**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
2426

@@ -371,6 +373,76 @@ Name | Type | Description | Notes
371373

372374
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
373375

376+
# **translation_unreview**
377+
> TranslationDetails translation_unreview(project_id, id, translation_unreview_parameters, x_phrase_app_otp=x_phrase_app_otp)
378+
379+
Unreview a translation
380+
381+
Mark a reviewed translation as translated.
382+
383+
### Example
384+
385+
```python
386+
from __future__ import print_function
387+
import time
388+
import phrase_api
389+
from phrase_api.rest import ApiException
390+
from pprint import pprint
391+
392+
configuration = phrase_api.Configuration()
393+
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
394+
configuration.api_key_prefix['Authorization'] = 'token'
395+
396+
# Enter a context with an instance of the API client
397+
with phrase_api.ApiClient(configuration) as api_client:
398+
# Create an instance of the API class
399+
api_instance = phrase_api.TranslationsApi(api_client)
400+
project_id = 'project_id_example' # str | Project ID (required)
401+
id = 'id_example' # str | ID (required)
402+
translation_unreview_parameters = phrase_api.TranslationUnreviewParameters() # TranslationUnreviewParameters | (required)
403+
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
404+
405+
try:
406+
# Unreview a translation
407+
api_response = api_instance.translation_unreview(project_id, id, translation_unreview_parameters, x_phrase_app_otp=x_phrase_app_otp)
408+
pprint(api_response)
409+
except ApiException as e:
410+
print("Exception when calling TranslationsApi->translation_unreview: %s\n" % e)
411+
```
412+
413+
414+
### Parameters
415+
416+
Name | Type | Description | Notes
417+
------------- | ------------- | ------------- | -------------
418+
**project_id** | **str**| Project ID |
419+
**id** | **str**| ID |
420+
**translation_unreview_parameters** | [**TranslationUnreviewParameters**](TranslationUnreviewParameters.md)| |
421+
**x_phrase_app_otp** | **str**| Two-Factor-Authentication token (optional) | [optional]
422+
423+
### Return type
424+
425+
[**TranslationDetails**](TranslationDetails.md)
426+
427+
### Authorization
428+
429+
[Basic](../README.md#Basic), [Token](../README.md#Token)
430+
431+
### HTTP request headers
432+
433+
- **Content-Type**: application/json
434+
- **Accept**: application/json
435+
436+
### HTTP response details
437+
| Status code | Description | Response headers |
438+
|-------------|-------------|------------------|
439+
**200** | OK | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
440+
**400** | Bad request | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
441+
**404** | Not Found | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
442+
**429** | Rate Limiting | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
443+
444+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
445+
374446
# **translation_unverify**
375447
> TranslationDetails translation_unverify(project_id, id, translation_unverify_parameters, x_phrase_app_otp=x_phrase_app_otp)
376448
@@ -1099,6 +1171,74 @@ Name | Type | Description | Notes
10991171

11001172
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
11011173

1174+
# **translations_unreview_collection**
1175+
> AffectedCount translations_unreview_collection(project_id, translations_unreview_parameters, x_phrase_app_otp=x_phrase_app_otp)
1176+
1177+
Unreview translations selected by query
1178+
1179+
Unreview translations matching query.
1180+
1181+
### Example
1182+
1183+
```python
1184+
from __future__ import print_function
1185+
import time
1186+
import phrase_api
1187+
from phrase_api.rest import ApiException
1188+
from pprint import pprint
1189+
1190+
configuration = phrase_api.Configuration()
1191+
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
1192+
configuration.api_key_prefix['Authorization'] = 'token'
1193+
1194+
# Enter a context with an instance of the API client
1195+
with phrase_api.ApiClient(configuration) as api_client:
1196+
# Create an instance of the API class
1197+
api_instance = phrase_api.TranslationsApi(api_client)
1198+
project_id = 'project_id_example' # str | Project ID (required)
1199+
translations_unreview_parameters = phrase_api.TranslationsUnreviewParameters() # TranslationsUnreviewParameters | (required)
1200+
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
1201+
1202+
try:
1203+
# Unreview translations selected by query
1204+
api_response = api_instance.translations_unreview_collection(project_id, translations_unreview_parameters, x_phrase_app_otp=x_phrase_app_otp)
1205+
pprint(api_response)
1206+
except ApiException as e:
1207+
print("Exception when calling TranslationsApi->translations_unreview_collection: %s\n" % e)
1208+
```
1209+
1210+
1211+
### Parameters
1212+
1213+
Name | Type | Description | Notes
1214+
------------- | ------------- | ------------- | -------------
1215+
**project_id** | **str**| Project ID |
1216+
**translations_unreview_parameters** | [**TranslationsUnreviewParameters**](TranslationsUnreviewParameters.md)| |
1217+
**x_phrase_app_otp** | **str**| Two-Factor-Authentication token (optional) | [optional]
1218+
1219+
### Return type
1220+
1221+
[**AffectedCount**](AffectedCount.md)
1222+
1223+
### Authorization
1224+
1225+
[Basic](../README.md#Basic), [Token](../README.md#Token)
1226+
1227+
### HTTP request headers
1228+
1229+
- **Content-Type**: application/json
1230+
- **Accept**: application/json
1231+
1232+
### HTTP response details
1233+
| Status code | Description | Response headers |
1234+
|-------------|-------------|------------------|
1235+
**200** | OK | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
1236+
**400** | Bad request | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
1237+
**404** | Not Found | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
1238+
**429** | Rate Limiting | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
1239+
1240+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1241+
11021242
# **translations_unverify_collection**
11031243
> AffectedCount translations_unverify_collection(project_id, translations_unverify_parameters, x_phrase_app_otp=x_phrase_app_otp)
11041244

‎docs/TranslationsUnreviewParameters.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# TranslationsUnreviewParameters
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**branch** | **str** | specify the branch to use | [optional]
7+
**q** | **str** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎phrase_api/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,7 @@
268268
from phrase_api.models.translation_order import TranslationOrder
269269
from phrase_api.models.translation_parent import TranslationParent
270270
from phrase_api.models.translation_review_parameters import TranslationReviewParameters
271+
from phrase_api.models.translation_unreview_parameters import TranslationUnreviewParameters
271272
from phrase_api.models.translation_unverify_parameters import TranslationUnverifyParameters
272273
from phrase_api.models.translation_update_parameters import TranslationUpdateParameters
273274
from phrase_api.models.translation_verify_parameters import TranslationVerifyParameters
@@ -277,6 +278,7 @@
277278
from phrase_api.models.translations_include_parameters import TranslationsIncludeParameters
278279
from phrase_api.models.translations_review_parameters import TranslationsReviewParameters
279280
from phrase_api.models.translations_search_parameters import TranslationsSearchParameters
281+
from phrase_api.models.translations_unreview_parameters import TranslationsUnreviewParameters
280282
from phrase_api.models.translations_unverify_parameters import TranslationsUnverifyParameters
281283
from phrase_api.models.translations_verify_parameters import TranslationsVerifyParameters
282284
from phrase_api.models.upload import Upload

0 commit comments

Comments
 (0)