Skip to content

Commit

Permalink
Deploying from phrase/openapi@d22c558a
Browse files Browse the repository at this point in the history
  • Loading branch information
Phrase committed Jan 17, 2024
1 parent 0940d70 commit 3b669c9
Show file tree
Hide file tree
Showing 37 changed files with 2,082 additions and 5 deletions.
27 changes: 27 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ docs/DistributionUpdateParameters.md
docs/DistributionsApi.md
docs/Document.md
docs/DocumentsApi.md
docs/Error.md
docs/ErrorError.md
docs/FigmaAttachment.md
docs/FigmaAttachmentCreateParameters.md
docs/FigmaAttachmentUpdateParameters.md
Expand Down Expand Up @@ -173,6 +175,13 @@ docs/ProjectReport.md
docs/ProjectShort.md
docs/ProjectUpdateParameters.md
docs/ProjectsApi.md
docs/ProjectsQualityPerformanceScore200Response.md
docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md
docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md
docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md
docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md
docs/ProjectsQualityPerformanceScoreRequest.md
docs/QualityPerformanceScoreApi.md
docs/Release.md
docs/ReleaseCreateParameters.md
docs/ReleasePreview.md
Expand Down Expand Up @@ -293,6 +302,7 @@ phrase_api/api/orders_api.py
phrase_api/api/organization_job_template_locales_api.py
phrase_api/api/organization_job_templates_api.py
phrase_api/api/projects_api.py
phrase_api/api/quality_performance_score_api.py
phrase_api/api/releases_api.py
phrase_api/api/reports_api.py
phrase_api/api/screenshot_markers_api.py
Expand Down Expand Up @@ -353,6 +363,8 @@ phrase_api/models/distribution_create_parameters.py
phrase_api/models/distribution_preview.py
phrase_api/models/distribution_update_parameters.py
phrase_api/models/document.py
phrase_api/models/error.py
phrase_api/models/error_error.py
phrase_api/models/figma_attachment.py
phrase_api/models/figma_attachment_create_parameters.py
phrase_api/models/figma_attachment_update_parameters.py
Expand Down Expand Up @@ -448,6 +460,12 @@ phrase_api/models/project_locales.py
phrase_api/models/project_report.py
phrase_api/models/project_short.py
phrase_api/models/project_update_parameters.py
phrase_api/models/projects_quality_performance_score200_response.py
phrase_api/models/projects_quality_performance_score200_response_any_of.py
phrase_api/models/projects_quality_performance_score200_response_any_of_data.py
phrase_api/models/projects_quality_performance_score200_response_any_of_data_translations_inner.py
phrase_api/models/projects_quality_performance_score200_response_any_of_errors_inner.py
phrase_api/models/projects_quality_performance_score_request.py
phrase_api/models/release.py
phrase_api/models/release_create_parameters.py
phrase_api/models/release_preview.py
Expand Down Expand Up @@ -572,6 +590,8 @@ test/test_distribution_update_parameters.py
test/test_distributions_api.py
test/test_document.py
test/test_documents_api.py
test/test_error.py
test/test_error_error.py
test/test_figma_attachment.py
test/test_figma_attachment_create_parameters.py
test/test_figma_attachment_update_parameters.py
Expand Down Expand Up @@ -690,6 +710,13 @@ test/test_project_report.py
test/test_project_short.py
test/test_project_update_parameters.py
test/test_projects_api.py
test/test_projects_quality_performance_score200_response.py
test/test_projects_quality_performance_score200_response_any_of.py
test/test_projects_quality_performance_score200_response_any_of_data.py
test/test_projects_quality_performance_score200_response_any_of_data_translations_inner.py
test/test_projects_quality_performance_score200_response_any_of_errors_inner.py
test/test_projects_quality_performance_score_request.py
test/test_quality_performance_score_api.py
test/test_release.py
test/test_release_create_parameters.py
test/test_release_preview.py
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ Class | Method | HTTP request | Description
*ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
*ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
*ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /projects | List projects
*QualityPerformanceScoreApi* | [**projects_quality_performance_score**](docs/QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{id}/quality_performance_score | Get project's translations' quality performance scores
*ReleasesApi* | [**release_create**](docs/ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
*ReleasesApi* | [**release_delete**](docs/ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
*ReleasesApi* | [**release_publish**](docs/ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release
Expand Down Expand Up @@ -447,6 +448,8 @@ Class | Method | HTTP request | Description
- [DistributionPreview](docs/DistributionPreview.md)
- [DistributionUpdateParameters](docs/DistributionUpdateParameters.md)
- [Document](docs/Document.md)
- [Error](docs/Error.md)
- [ErrorError](docs/ErrorError.md)
- [FigmaAttachment](docs/FigmaAttachment.md)
- [FigmaAttachmentCreateParameters](docs/FigmaAttachmentCreateParameters.md)
- [FigmaAttachmentUpdateParameters](docs/FigmaAttachmentUpdateParameters.md)
Expand Down Expand Up @@ -542,6 +545,12 @@ Class | Method | HTTP request | Description
- [ProjectReport](docs/ProjectReport.md)
- [ProjectShort](docs/ProjectShort.md)
- [ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
- [ProjectsQualityPerformanceScore200Response](docs/ProjectsQualityPerformanceScore200Response.md)
- [ProjectsQualityPerformanceScore200ResponseAnyOf](docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md)
- [ProjectsQualityPerformanceScore200ResponseAnyOfData](docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md)
- [ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md)
- [ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md)
- [ProjectsQualityPerformanceScoreRequest](docs/ProjectsQualityPerformanceScoreRequest.md)
- [Release](docs/Release.md)
- [ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
- [ReleasePreview](docs/ReleasePreview.md)
Expand Down
11 changes: 11 additions & 0 deletions docs/Error.md
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)


11 changes: 11 additions & 0 deletions docs/ErrorError.md
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)


12 changes: 12 additions & 0 deletions docs/ProjectsQualityPerformanceScore200Response.md
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)


11 changes: 11 additions & 0 deletions docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md
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 docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md
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)


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 docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md
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)


10 changes: 10 additions & 0 deletions docs/ProjectsQualityPerformanceScoreRequest.md
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)


80 changes: 80 additions & 0 deletions docs/QualityPerformanceScoreApi.md
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)

9 changes: 9 additions & 0 deletions phrase_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
from phrase_api.api.organization_job_template_locales_api import OrganizationJobTemplateLocalesApi
from phrase_api.api.organization_job_templates_api import OrganizationJobTemplatesApi
from phrase_api.api.projects_api import ProjectsApi
from phrase_api.api.quality_performance_score_api import QualityPerformanceScoreApi
from phrase_api.api.releases_api import ReleasesApi
from phrase_api.api.reports_api import ReportsApi
from phrase_api.api.screenshot_markers_api import ScreenshotMarkersApi
Expand Down Expand Up @@ -116,6 +117,8 @@
from phrase_api.models.distribution_preview import DistributionPreview
from phrase_api.models.distribution_update_parameters import DistributionUpdateParameters
from phrase_api.models.document import Document
from phrase_api.models.error import Error
from phrase_api.models.error_error import ErrorError
from phrase_api.models.figma_attachment import FigmaAttachment
from phrase_api.models.figma_attachment_create_parameters import FigmaAttachmentCreateParameters
from phrase_api.models.figma_attachment_update_parameters import FigmaAttachmentUpdateParameters
Expand Down Expand Up @@ -211,6 +214,12 @@
from phrase_api.models.project_report import ProjectReport
from phrase_api.models.project_short import ProjectShort
from phrase_api.models.project_update_parameters import ProjectUpdateParameters
from phrase_api.models.projects_quality_performance_score200_response import ProjectsQualityPerformanceScore200Response
from phrase_api.models.projects_quality_performance_score200_response_any_of import ProjectsQualityPerformanceScore200ResponseAnyOf
from phrase_api.models.projects_quality_performance_score200_response_any_of_data import ProjectsQualityPerformanceScore200ResponseAnyOfData
from phrase_api.models.projects_quality_performance_score200_response_any_of_data_translations_inner import ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner
from phrase_api.models.projects_quality_performance_score200_response_any_of_errors_inner import ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner
from phrase_api.models.projects_quality_performance_score_request import ProjectsQualityPerformanceScoreRequest
from phrase_api.models.release import Release
from phrase_api.models.release_create_parameters import ReleaseCreateParameters
from phrase_api.models.release_preview import ReleasePreview
Expand Down
1 change: 1 addition & 0 deletions phrase_api/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
from phrase_api.api.organization_job_template_locales_api import OrganizationJobTemplateLocalesApi
from phrase_api.api.organization_job_templates_api import OrganizationJobTemplatesApi
from phrase_api.api.projects_api import ProjectsApi
from phrase_api.api.quality_performance_score_api import QualityPerformanceScoreApi
from phrase_api.api.releases_api import ReleasesApi
from phrase_api.api.reports_api import ReportsApi
from phrase_api.api.screenshot_markers_api import ScreenshotMarkersApi
Expand Down
Loading

0 comments on commit 3b669c9

Please sign in to comment.