phrase-api 3.4.0__tar.gz → 3.6.0__tar.gz

{phrase_api-3.4.0 → phrase_api-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: phrase-api
-Version: 3.4.0
+Version: 3.6.0
 Summary: Phrase Strings API Reference
 Home-page: https://github.com/phrase/phrase-python
 Author: Phrase Support

{phrase_api-3.4.0 → phrase_api-3.6.0}/README.md

@@ -5,7 +5,7 @@ Phrase Strings is a translation management platform for software projects. You c
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 3.4.0
+- Package version: 3.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -221,6 +221,12 @@ Class | Method | HTTP request | Description
 *InvitationsApi* | [**invitation_update**](docs/InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
 *InvitationsApi* | [**invitation_update_settings**](docs/InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
 *InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
+*JobAnnotationsApi* | [**job_annotation_delete**](docs/JobAnnotationsApi.md#job_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Delete a job annotation
+*JobAnnotationsApi* | [**job_annotation_update**](docs/JobAnnotationsApi.md#job_annotation_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Create/Update a job annotation
+*JobAnnotationsApi* | [**job_annotations_list**](docs/JobAnnotationsApi.md#job_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/annotations | List job annotations
+*JobAnnotationsApi* | [**job_locale_annotation_delete**](docs/JobAnnotationsApi.md#job_locale_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Delete a job locale annotation
+*JobAnnotationsApi* | [**job_locale_annotation_update**](docs/JobAnnotationsApi.md#job_locale_annotation_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Create/Update a job locale annotation
+*JobAnnotationsApi* | [**job_locale_annotations_list**](docs/JobAnnotationsApi.md#job_locale_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations | List job locale annotations
 *JobCommentsApi* | [**job_comment_create**](docs/JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
 *JobCommentsApi* | [**job_comment_delete**](docs/JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
 *JobCommentsApi* | [**job_comment_show**](docs/JobCommentsApi.md#job_comment_show) | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
@@ -475,6 +481,9 @@ Class | Method | HTTP request | Description
  - [InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
  - [InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
  - [Job](docs/Job.md)
+ - [JobAnnotation](docs/JobAnnotation.md)
+ - [JobAnnotationShort](docs/JobAnnotationShort.md)
+ - [JobAnnotationUpdateParameters](docs/JobAnnotationUpdateParameters.md)
  - [JobComment](docs/JobComment.md)
  - [JobCommentCreateParameters](docs/JobCommentCreateParameters.md)
  - [JobCommentUpdateParameters](docs/JobCommentUpdateParameters.md)

{phrase_api-3.4.0 → phrase_api-3.6.0}/phrase_api/__init__.py

@@ -13,7 +13,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "3.4.0"
+__version__ = "3.6.0"
 
 # import apis into sdk package
 from phrase_api.api.accounts_api import AccountsApi
@@ -33,6 +33,7 @@ from phrase_api.api.glossary_term_translations_api import GlossaryTermTranslatio
 from phrase_api.api.glossary_terms_api import GlossaryTermsApi
 from phrase_api.api.icu_api import ICUApi
 from phrase_api.api.invitations_api import InvitationsApi
+from phrase_api.api.job_annotations_api import JobAnnotationsApi
 from phrase_api.api.job_comments_api import JobCommentsApi
 from phrase_api.api.job_locales_api import JobLocalesApi
 from phrase_api.api.job_template_locales_api import JobTemplateLocalesApi
@@ -137,6 +138,9 @@ from phrase_api.models.invitation_create_parameters import InvitationCreateParam
 from phrase_api.models.invitation_update_parameters import InvitationUpdateParameters
 from phrase_api.models.invitation_update_settings_parameters import InvitationUpdateSettingsParameters
 from phrase_api.models.job import Job
+from phrase_api.models.job_annotation import JobAnnotation
+from phrase_api.models.job_annotation_short import JobAnnotationShort
+from phrase_api.models.job_annotation_update_parameters import JobAnnotationUpdateParameters
 from phrase_api.models.job_comment import JobComment
 from phrase_api.models.job_comment_create_parameters import JobCommentCreateParameters
 from phrase_api.models.job_comment_update_parameters import JobCommentUpdateParameters

{phrase_api-3.4.0 → phrase_api-3.6.0}/phrase_api/api/__init__.py

@@ -20,6 +20,7 @@ from phrase_api.api.glossary_term_translations_api import GlossaryTermTranslatio
 from phrase_api.api.glossary_terms_api import GlossaryTermsApi
 from phrase_api.api.icu_api import ICUApi
 from phrase_api.api.invitations_api import InvitationsApi
+from phrase_api.api.job_annotations_api import JobAnnotationsApi
 from phrase_api.api.job_comments_api import JobCommentsApi
 from phrase_api.api.job_locales_api import JobLocalesApi
 from phrase_api.api.job_template_locales_api import JobTemplateLocalesApi

{phrase_api-3.4.0 → phrase_api-3.6.0}/phrase_api/api/branches_api.py

@@ -38,7 +38,7 @@ class BranchesApi(object):
     def branch_compare(self, project_id, name, **kwargs):  # noqa: E501
         """Compare branches  # noqa: E501
 
-        Compare branch with main branch. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>  # noqa: E501
+        Compare branch with main branch.   *Note: Comparing a branch may take several minutes depending on the project size.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_compare(project_id, name, async_req=True)
@@ -65,7 +65,7 @@ class BranchesApi(object):
     def branch_compare_with_http_info(self, project_id, name, **kwargs):  # noqa: E501
         """Compare branches  # noqa: E501
 
-        Compare branch with main branch. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>  # noqa: E501
+        Compare branch with main branch.   *Note: Comparing a branch may take several minutes depending on the project size.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_compare_with_http_info(project_id, name, async_req=True)
@@ -162,7 +162,7 @@ class BranchesApi(object):
     def branch_create(self, project_id, branch_create_parameters, **kwargs):  # noqa: E501
         """Create a branch  # noqa: E501
 
-        Create a new branch. <br><br><i>Note: Creating a new branch may take several minutes depending on the project size.</i>  # noqa: E501
+        Create a new branch.  *Note: Creating a new branch may take several minutes depending on the project size.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_create(project_id, branch_create_parameters, async_req=True)
@@ -189,7 +189,7 @@ class BranchesApi(object):
     def branch_create_with_http_info(self, project_id, branch_create_parameters, **kwargs):  # noqa: E501
         """Create a branch  # noqa: E501
 
-        Create a new branch. <br><br><i>Note: Creating a new branch may take several minutes depending on the project size.</i>  # noqa: E501
+        Create a new branch.  *Note: Creating a new branch may take several minutes depending on the project size.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_create_with_http_info(project_id, branch_create_parameters, async_req=True)
@@ -418,7 +418,7 @@ class BranchesApi(object):
     def branch_merge(self, project_id, name, branch_merge_parameters, **kwargs):  # noqa: E501
         """Merge a branch  # noqa: E501
 
-        Merge an existing branch. <br><br><i>Note: Merging a branch may take several minutes depending on diff size.</i>  # noqa: E501
+        Merge an existing branch.   *Note: Merging a branch may take several minutes depending on diff size.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_merge(project_id, name, branch_merge_parameters, async_req=True)
@@ -446,7 +446,7 @@ class BranchesApi(object):
     def branch_merge_with_http_info(self, project_id, name, branch_merge_parameters, **kwargs):  # noqa: E501
         """Merge a branch  # noqa: E501
 
-        Merge an existing branch. <br><br><i>Note: Merging a branch may take several minutes depending on diff size.</i>  # noqa: E501
+        Merge an existing branch.   *Note: Merging a branch may take several minutes depending on diff size.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_merge_with_http_info(project_id, name, branch_merge_parameters, async_req=True)

{phrase_api-3.4.0 → phrase_api-3.6.0}/phrase_api/api/invitations_api.py

@@ -38,7 +38,7 @@ class InvitationsApi(object):
     def invitation_create(self, account_id, invitation_create_parameters, **kwargs):  # noqa: E501
         """Create a new invitation  # noqa: E501
 
-        Invite a person to an account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Invite a person to an account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_create(account_id, invitation_create_parameters, async_req=True)
@@ -65,7 +65,7 @@ class InvitationsApi(object):
     def invitation_create_with_http_info(self, account_id, invitation_create_parameters, **kwargs):  # noqa: E501
         """Create a new invitation  # noqa: E501
 
-        Invite a person to an account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Invite a person to an account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_create_with_http_info(account_id, invitation_create_parameters, async_req=True)
@@ -170,7 +170,7 @@ class InvitationsApi(object):
     def invitation_delete(self, account_id, id, **kwargs):  # noqa: E501
         """Delete an invitation  # noqa: E501
 
-        Delete an existing invitation (must not be accepted yet). Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_delete(account_id, id, async_req=True)
@@ -197,7 +197,7 @@ class InvitationsApi(object):
     def invitation_delete_with_http_info(self, account_id, id, **kwargs):  # noqa: E501
         """Delete an invitation  # noqa: E501
 
-        Delete an existing invitation (must not be accepted yet). Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_delete_with_http_info(account_id, id, async_req=True)
@@ -294,7 +294,7 @@ class InvitationsApi(object):
     def invitation_resend(self, account_id, id, **kwargs):  # noqa: E501
         """Resend an invitation  # noqa: E501
 
-        Resend the invitation email (must not be accepted yet). Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_resend(account_id, id, async_req=True)
@@ -321,7 +321,7 @@ class InvitationsApi(object):
     def invitation_resend_with_http_info(self, account_id, id, **kwargs):  # noqa: E501
         """Resend an invitation  # noqa: E501
 
-        Resend the invitation email (must not be accepted yet). Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_resend_with_http_info(account_id, id, async_req=True)
@@ -422,7 +422,7 @@ class InvitationsApi(object):
     def invitation_show(self, account_id, id, **kwargs):  # noqa: E501
         """Get a single invitation  # noqa: E501
 
-        Get details on a single invitation. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Get details on a single invitation. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_show(account_id, id, async_req=True)
@@ -449,7 +449,7 @@ class InvitationsApi(object):
     def invitation_show_with_http_info(self, account_id, id, **kwargs):  # noqa: E501
         """Get a single invitation  # noqa: E501
 
-        Get details on a single invitation. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Get details on a single invitation. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_show_with_http_info(account_id, id, async_req=True)
@@ -550,7 +550,7 @@ class InvitationsApi(object):
     def invitation_update(self, account_id, id, invitation_update_parameters, **kwargs):  # noqa: E501
         """Update an invitation  # noqa: E501
 
-        Update an existing invitation (must not be accepted yet). The <code>email</code> cannot be updated. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Update an existing invitation (must not be accepted yet). The `email` cannot be updated. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_update(account_id, id, invitation_update_parameters, async_req=True)
@@ -578,7 +578,7 @@ class InvitationsApi(object):
     def invitation_update_with_http_info(self, account_id, id, invitation_update_parameters, **kwargs):  # noqa: E501
         """Update an invitation  # noqa: E501
 
-        Update an existing invitation (must not be accepted yet). The <code>email</code> cannot be updated. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Update an existing invitation (must not be accepted yet). The `email` cannot be updated. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_update_with_http_info(account_id, id, invitation_update_parameters, async_req=True)
@@ -691,7 +691,7 @@ class InvitationsApi(object):
     def invitation_update_settings(self, project_id, id, invitation_update_settings_parameters, **kwargs):  # noqa: E501
         """Update a member's invitation access  # noqa: E501
 
-        Update member's settings in the invitations. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Update member's settings in the invitations. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_update_settings(project_id, id, invitation_update_settings_parameters, async_req=True)
@@ -719,7 +719,7 @@ class InvitationsApi(object):
     def invitation_update_settings_with_http_info(self, project_id, id, invitation_update_settings_parameters, **kwargs):  # noqa: E501
         """Update a member's invitation access  # noqa: E501
 
-        Update member's settings in the invitations. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        Update member's settings in the invitations. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitation_update_settings_with_http_info(project_id, id, invitation_update_settings_parameters, async_req=True)
@@ -832,7 +832,7 @@ class InvitationsApi(object):
     def invitations_list(self, account_id, **kwargs):  # noqa: E501
         """List invitations  # noqa: E501
 
-        List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitations_list(account_id, async_req=True)
@@ -860,7 +860,7 @@ class InvitationsApi(object):
     def invitations_list_with_http_info(self, account_id, **kwargs):  # noqa: E501
         """List invitations  # noqa: E501
 
-        List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.  # noqa: E501
+        List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.invitations_list_with_http_info(account_id, async_req=True)