-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying from phrase/openapi@d22c558a
- Loading branch information
Phrase
committed
Jan 17, 2024
1 parent
0940d70
commit 3b669c9
Showing
37 changed files
with
2,082 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Error | ||
|
||
Error field for when the request completely fails | ||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**error** | [**ErrorError**](ErrorError.md) | | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# ErrorError | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**message** | **str** | | [optional] | ||
**code** | **str** | | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# ProjectsQualityPerformanceScore200Response | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**error** | [**ErrorError**](ErrorError.md) | | [optional] | ||
**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional] | ||
**errors** | [**List[ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner]**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# ProjectsQualityPerformanceScore200ResponseAnyOf | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional] | ||
**errors** | [**List[ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner]**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] | ||
|
||
[[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 changes: 10 additions & 0 deletions
10
docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# ProjectsQualityPerformanceScore200ResponseAnyOfData | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**translations** | [**List[ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner]**](ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md) | | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
12 changes: 12 additions & 0 deletions
12
docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**engine** | **str** | Engine used for the translation scoring | [optional] | ||
**score** | **float** | Quality score for the translation | [optional] | ||
**id** | **str** | One of the translation ids passed in arguments | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
12 changes: 12 additions & 0 deletions
12
docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**message** | **str** | | [optional] | ||
**code** | **str** | | [optional] | ||
**id** | **str** | One of the translation ids passed in arguments | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# ProjectsQualityPerformanceScoreRequest | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**translation_ids** | **List[str]** | Translation ids you want to get the quality performance score for | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# phrase_api.QualityPerformanceScoreApi | ||
|
||
All URIs are relative to *https://api.phrase.com/v2* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**projects_quality_performance_score**](QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{id}/quality_performance_score | Get project's translations' quality performance scores | ||
|
||
|
||
# **projects_quality_performance_score** | ||
> ProjectsQualityPerformanceScore200Response projects_quality_performance_score(id, projects_quality_performance_score_request, x_phrase_app_otp=x_phrase_app_otp) | ||
Get project's translations' quality performance scores | ||
|
||
Get project's translations' quality performance scores | ||
|
||
### Example | ||
|
||
```python | ||
from __future__ import print_function | ||
import time | ||
import phrase_api | ||
from phrase_api.rest import ApiException | ||
from pprint import pprint | ||
|
||
configuration = phrase_api.Configuration() | ||
configuration.api_key['Authorization'] = 'YOUR_API_KEY' | ||
configuration.api_key_prefix['Authorization'] = 'token' | ||
|
||
# Enter a context with an instance of the API client | ||
with phrase_api.ApiClient(configuration) as api_client: | ||
# Create an instance of the API class | ||
api_instance = phrase_api.QualityPerformanceScoreApi(api_client) | ||
id = 'id_example' # str | ID (required) | ||
projects_quality_performance_score_request = phrase_api.ProjectsQualityPerformanceScoreRequest() # ProjectsQualityPerformanceScoreRequest | (required) | ||
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional) | ||
|
||
try: | ||
# Get project's translations' quality performance scores | ||
api_response = api_instance.projects_quality_performance_score(id, projects_quality_performance_score_request, x_phrase_app_otp=x_phrase_app_otp) | ||
pprint(api_response) | ||
except ApiException as e: | ||
print("Exception when calling QualityPerformanceScoreApi->projects_quality_performance_score: %s\n" % e) | ||
``` | ||
|
||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**id** | **str**| ID | | ||
**projects_quality_performance_score_request** | [**ProjectsQualityPerformanceScoreRequest**](ProjectsQualityPerformanceScoreRequest.md)| | | ||
**x_phrase_app_otp** | **str**| Two-Factor-Authentication token (optional) | [optional] | ||
|
||
### Return type | ||
|
||
[**ProjectsQualityPerformanceScore200Response**](ProjectsQualityPerformanceScore200Response.md) | ||
|
||
### Authorization | ||
|
||
[Basic](../README.md#Basic), [Token](../README.md#Token) | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json | ||
- **Accept**: application/json | ||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
**200** | OK | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
**400** | Bad request | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
**401** | Unauthorized | - | | ||
**404** | Not Found | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
**422** | Unprocessable entity | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
**429** | Rate Limiting | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
**504** | Gateway timeout | - | | ||
|
||
[[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) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.