phrase 3.7.0 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +63 -0
- data/README.md +13 -37
- data/docs/JobCommentCreateParameters.md +3 -1
- data/docs/JobCommentUpdateParameters.md +3 -1
- data/docs/JobCommentsApi.md +6 -6
- data/docs/JobDetails.md +2 -0
- data/docs/JobKeysDeleteParameters.md +19 -0
- data/docs/JobLocalesApi.md +6 -6
- data/docs/JobsApi.md +16 -14
- data/docs/KeyCreateParameters.md +1 -1
- data/docs/KeyUpdateParameters.md +1 -1
- data/docs/KeysApi.md +4 -4
- data/docs/KeysExcludeParameters.md +1 -1
- data/docs/KeysIncludeParameters.md +1 -1
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/LocalesApi.md +3 -1
- data/docs/ProjectCreateParameters.md +1 -1
- data/docs/ProjectUpdateParameters.md +4 -2
- data/docs/QualityPerformanceScoreApi.md +8 -8
- data/docs/QualityPerformanceScoreList200Response.md +21 -0
- data/docs/QualityPerformanceScoreList200ResponseAnyOf.md +19 -0
- data/docs/QualityPerformanceScoreList200ResponseAnyOfData.md +17 -0
- data/docs/{ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md → QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner.md} +2 -2
- data/docs/{ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md → QualityPerformanceScoreList200ResponseAnyOfErrorsInner.md} +2 -2
- data/docs/{ProjectsQualityPerformanceScoreRequest.md → QualityPerformanceScoreListRequest.md} +2 -2
- data/docs/RepoSyncEvent.md +3 -3
- data/docs/RepoSyncEventsApi.md +138 -0
- data/docs/RepoSyncsApi.md +2 -132
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/Upload.md +3 -1
- data/lib/phrase/api/job_comments_api.rb +6 -6
- data/lib/phrase/api/job_locales_api.rb +6 -6
- data/lib/phrase/api/jobs_api.rb +24 -16
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locales_api.rb +3 -0
- data/lib/phrase/api/quality_performance_score_api.rb +15 -15
- data/lib/phrase/api/repo_sync_events_api.rb +160 -0
- data/lib/phrase/api/repo_syncs_api.rb +4 -154
- data/lib/phrase/models/job_comment_create_parameters.rb +14 -4
- data/lib/phrase/models/job_comment_update_parameters.rb +14 -4
- data/lib/phrase/models/job_details.rb +10 -1
- data/lib/phrase/models/job_keys_delete_parameters.rb +214 -0
- data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
- data/lib/phrase/models/keys_include_parameters.rb +1 -1
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/project_update_parameters.rb +48 -4
- data/lib/phrase/models/{projects_quality_performance_score200_response.rb → quality_performance_score_list200_response.rb} +6 -6
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of.rb → quality_performance_score_list200_response_any_of.rb} +5 -5
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of_data.rb → quality_performance_score_list200_response_any_of_data.rb} +4 -4
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of_data_translations_inner.rb → quality_performance_score_list200_response_any_of_data_translations_inner.rb} +3 -3
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of_errors_inner.rb → quality_performance_score_list200_response_any_of_errors_inner.rb} +3 -3
- data/lib/phrase/models/{projects_quality_performance_score_request.rb → quality_performance_score_list_request.rb} +3 -3
- data/lib/phrase/models/repo_sync_event.rb +15 -15
- data/lib/phrase/models/upload.rb +14 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +8 -22
- data/spec/api/job_comments_api_spec.rb +3 -3
- data/spec/api/job_locales_api_spec.rb +3 -3
- data/spec/api/jobs_api_spec.rb +6 -5
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/quality_performance_score_api_spec.rb +4 -4
- data/spec/api/repo_sync_events_api_spec.rb +52 -0
- data/spec/api/repo_syncs_api_spec.rb +2 -31
- data/spec/models/job_comment_create_parameters_spec.rb +6 -0
- data/spec/models/job_comment_update_parameters_spec.rb +6 -0
- data/spec/models/job_details_spec.rb +6 -0
- data/spec/models/{gitlab_sync_export_spec.rb → job_keys_delete_parameters_spec.rb} +8 -8
- data/spec/models/project_update_parameters_spec.rb +10 -0
- data/spec/models/quality_performance_score_list200_response_any_of_data_spec.rb +29 -0
- data/spec/models/{projects_quality_performance_score200_response_any_of_data_translations_inner_spec.rb → quality_performance_score_list200_response_any_of_data_translations_inner_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score200_response_any_of_errors_inner_spec.rb → quality_performance_score_list200_response_any_of_errors_inner_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score200_response_any_of_spec.rb → quality_performance_score_list200_response_any_of_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score200_response_spec.rb → quality_performance_score_list200_response_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score_request_spec.rb → quality_performance_score_list_request_spec.rb} +6 -6
- data/spec/models/repo_sync_event_spec.rb +2 -2
- data/spec/models/upload_spec.rb +6 -0
- metadata +265 -321
- data/docs/BitbucketSync.md +0 -27
- data/docs/BitbucketSyncApi.md +0 -197
- data/docs/BitbucketSyncExportParameters.md +0 -17
- data/docs/BitbucketSyncExportResponse.md +0 -17
- data/docs/BitbucketSyncImportParameters.md +0 -17
- data/docs/GitHubSyncApi.md +0 -130
- data/docs/GitLabSyncApi.md +0 -463
- data/docs/GithubSyncExportParameters.md +0 -17
- data/docs/GithubSyncImportParameters.md +0 -17
- data/docs/GitlabSync.md +0 -37
- data/docs/GitlabSyncExport.md +0 -19
- data/docs/GitlabSyncExportParameters.md +0 -17
- data/docs/GitlabSyncHistory.md +0 -25
- data/docs/GitlabSyncHistoryErrorsInner.md +0 -19
- data/docs/GitlabSyncImportParameters.md +0 -17
- data/docs/ProjectsQualityPerformanceScore200Response.md +0 -21
- data/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md +0 -19
- data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md +0 -17
- data/docs/RepoSyncEventErrorsInner.md +0 -16
- data/lib/phrase/api/bitbucket_sync_api.rb +0 -219
- data/lib/phrase/api/git_hub_sync_api.rb +0 -146
- data/lib/phrase/api/git_lab_sync_api.rb +0 -510
- data/lib/phrase/models/bitbucket_sync.rb +0 -243
- data/lib/phrase/models/bitbucket_sync_export_parameters.rb +0 -197
- data/lib/phrase/models/bitbucket_sync_export_response.rb +0 -196
- data/lib/phrase/models/bitbucket_sync_import_parameters.rb +0 -197
- data/lib/phrase/models/github_sync_export_parameters.rb +0 -197
- data/lib/phrase/models/github_sync_import_parameters.rb +0 -197
- data/lib/phrase/models/gitlab_sync.rb +0 -286
- data/lib/phrase/models/gitlab_sync_export.rb +0 -205
- data/lib/phrase/models/gitlab_sync_export_parameters.rb +0 -197
- data/lib/phrase/models/gitlab_sync_history.rb +0 -234
- data/lib/phrase/models/gitlab_sync_history_errors_inner.rb +0 -205
- data/lib/phrase/models/gitlab_sync_import_parameters.rb +0 -197
- data/lib/phrase/models/repo_sync_event_errors_inner.rb +0 -207
- data/spec/api/bitbucket_sync_api_spec.rb +0 -64
- data/spec/api/git_hub_sync_api_spec.rb +0 -49
- data/spec/api/git_lab_sync_api_spec.rb +0 -125
- data/spec/models/bitbucket_sync_export_parameters_spec.rb +0 -29
- data/spec/models/bitbucket_sync_export_response_spec.rb +0 -29
- data/spec/models/bitbucket_sync_import_parameters_spec.rb +0 -29
- data/spec/models/bitbucket_sync_spec.rb +0 -59
- data/spec/models/github_sync_export_parameters_spec.rb +0 -29
- data/spec/models/github_sync_import_parameters_spec.rb +0 -29
- data/spec/models/gitlab_sync_export_parameters_spec.rb +0 -29
- data/spec/models/gitlab_sync_history_errors_inner_spec.rb +0 -35
- data/spec/models/gitlab_sync_history_spec.rb +0 -53
- data/spec/models/gitlab_sync_import_parameters_spec.rb +0 -29
- data/spec/models/gitlab_sync_spec.rb +0 -89
- data/spec/models/projects_quality_performance_score200_response_any_of_data_spec.rb +0 -29
- data/spec/models/repo_sync_event_errors_inner_spec.rb +0 -23
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2ea767baced3288f7897a3efb16e9830827ffd36400dc5e7f86d88add72f01ac
|
|
4
|
+
data.tar.gz: f215cb32ca872a03b53692e50582b7ffa7c7cbb61dad4e49ae62dca68363adf4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8d3caf3af4cbe1a17636d3f418fb0d2ab2ba8d40320dbabc568c0b1c836991b133529c19940544f1293b9953bc438d22bce0fefe9af8c46d7c11e2b84c442547
|
|
7
|
+
data.tar.gz: 0f36ac533a33565c2ea3016bb605c72f9c193c79e9939c729e9a1549afa3d848d7cd9f5d05e0377e67b7232e80b8a2a1cd652b35d0e10613ee17deb470c6237b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,68 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.3.0](https://github.com/phrase/openapi/compare/ruby-v4.2.0...ruby-v4.3.0) (2025-02-21)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **API:** add updated_since filter to job list #STRINGS-1555 ([#799](https://github.com/phrase/openapi/issues/799)) ([dc9b6ed](https://github.com/phrase/openapi/commit/dc9b6ed12e013231d397820449086c87fea2f8ba))
|
|
9
|
+
|
|
10
|
+
## [4.2.0](https://github.com/phrase/openapi/compare/ruby-v4.1.0...ruby-v4.2.0) (2025-02-17)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **API:** document tags attribute of an upload #STRINGS-1221 ([#790](https://github.com/phrase/openapi/issues/790)) ([fff505b](https://github.com/phrase/openapi/commit/fff505bdff35a0033fee06e505c42fe794c88562))
|
|
16
|
+
|
|
17
|
+
## [4.1.0](https://github.com/phrase/openapi/compare/ruby-v4.0.3...ruby-v4.1.0) (2025-02-17)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* **API:** Add locale_ids param to synchronous download endpoint [STRINGS-1492] ([#780](https://github.com/phrase/openapi/issues/780)) ([47186a4](https://github.com/phrase/openapi/commit/47186a44fc8c0b8e466636acf3d49413b1f29f30))
|
|
23
|
+
* **API:** Add source last updated at information on job details ([#777](https://github.com/phrase/openapi/issues/777)) ([c9b8423](https://github.com/phrase/openapi/commit/c9b8423766b4138980d0553502b3e18ca524f34e))
|
|
24
|
+
|
|
25
|
+
## [4.0.3](https://github.com/phrase/openapi/compare/ruby-v4.0.2...ruby-v4.0.3) (2025-01-29)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### Bug Fixes
|
|
29
|
+
|
|
30
|
+
* **API:** pass translation_key_ids when removing keys from job ([#771](https://github.com/phrase/openapi/issues/771)) ([f670e27](https://github.com/phrase/openapi/commit/f670e2763b1112fefd1812109b3c09def42b7bd2))
|
|
31
|
+
|
|
32
|
+
## [4.0.2](https://github.com/phrase/openapi/compare/ruby-v4.0.1...ruby-v4.0.2) (2025-01-06)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Bug Fixes
|
|
36
|
+
|
|
37
|
+
* **CLI:** Adjust operationId for quality_performance_score #STRINGS-1104 ([#721](https://github.com/phrase/openapi/issues/721)) ([7aa3b9b](https://github.com/phrase/openapi/commit/7aa3b9b508d1d24a4af7f4977b1a2fead8bfda78))
|
|
38
|
+
|
|
39
|
+
## [4.0.1](https://github.com/phrase/openapi/compare/ruby-v4.0.0...ruby-v4.0.1) (2024-12-20)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Bug Fixes
|
|
43
|
+
|
|
44
|
+
* **API:** Repo Sync Event errors field type #STRINGS-1074 ([#756](https://github.com/phrase/openapi/issues/756)) ([c7670e0](https://github.com/phrase/openapi/commit/c7670e04810f95359d72ba6346b5f626bfb77b6f))
|
|
45
|
+
* **API:** Repo Sync schema fixes #STRINGS-1074 ([#748](https://github.com/phrase/openapi/issues/748)) ([033be10](https://github.com/phrase/openapi/commit/033be1003fe01b5115de1f8ba2336d32b4862bfd))
|
|
46
|
+
|
|
47
|
+
## [4.0.0](https://github.com/phrase/openapi/compare/ruby-v3.7.1...ruby-v4.0.0) (2024-12-18)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### ⚠ BREAKING CHANGES
|
|
51
|
+
|
|
52
|
+
* Remove old Git sync endpoints. Replaced with new repo sync ([#735](https://github.com/phrase/openapi/issues/735))
|
|
53
|
+
|
|
54
|
+
### Features
|
|
55
|
+
|
|
56
|
+
* **API:** Add 'default_encoding' documentation ([#733](https://github.com/phrase/openapi/issues/733)) ([0139c51](https://github.com/phrase/openapi/commit/0139c51da747fbe7bc9929bcf3534aad7f22f39a))
|
|
57
|
+
* Remove old Git sync endpoints. Replaced with new repo sync ([#735](https://github.com/phrase/openapi/issues/735)) ([c3bd8ec](https://github.com/phrase/openapi/commit/c3bd8eccaabcfa1b1066ea4438971ac59833af46))
|
|
58
|
+
|
|
59
|
+
## [3.7.1](https://github.com/phrase/openapi/compare/ruby-v3.7.0...ruby-v3.7.1) (2024-12-09)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### Bug Fixes
|
|
63
|
+
|
|
64
|
+
* **API:** Add missing branch parameter to job comment endpoints #STRINGS-988 ([#724](https://github.com/phrase/openapi/issues/724)) ([64d399c](https://github.com/phrase/openapi/commit/64d399ced0980ac2a48366f91110047287a0c590))
|
|
65
|
+
|
|
3
66
|
## [3.7.0](https://github.com/phrase/openapi/compare/ruby-v3.6.0...ruby-v3.7.0) (2024-12-03)
|
|
4
67
|
|
|
5
68
|
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
|
|
|
7
7
|
## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 3.
|
|
10
|
+
- Package version: 4.3.0
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
|
|
13
13
|
|
|
@@ -56,10 +56,10 @@ gem build phrase.gemspec
|
|
|
56
56
|
Then install the gem locally:
|
|
57
57
|
|
|
58
58
|
```shell
|
|
59
|
-
gem install ./phrase-3.
|
|
59
|
+
gem install ./phrase-4.3.0.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./phrase-3.
|
|
62
|
+
(for development, run `gem install --dev ./phrase-4.3.0.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
## Getting Started
|
|
65
65
|
|
|
@@ -137,9 +137,6 @@ Class | Method | HTTP request | Description
|
|
|
137
137
|
*Phrase::AuthorizationsApi* | [**authorization_show**](docs/AuthorizationsApi.md#authorization_show) | **GET** /authorizations/{id} | Get a single authorization
|
|
138
138
|
*Phrase::AuthorizationsApi* | [**authorization_update**](docs/AuthorizationsApi.md#authorization_update) | **PATCH** /authorizations/{id} | Update an authorization
|
|
139
139
|
*Phrase::AuthorizationsApi* | [**authorizations_list**](docs/AuthorizationsApi.md#authorizations_list) | **GET** /authorizations | List authorizations
|
|
140
|
-
*Phrase::BitbucketSyncApi* | [**bitbucket_sync_export**](docs/BitbucketSyncApi.md#bitbucket_sync_export) | **POST** /bitbucket_syncs/{id}/export | Export from Phrase Strings to Bitbucket
|
|
141
|
-
*Phrase::BitbucketSyncApi* | [**bitbucket_sync_import**](docs/BitbucketSyncApi.md#bitbucket_sync_import) | **POST** /bitbucket_syncs/{id}/import | Import to Phrase Strings from Bitbucket
|
|
142
|
-
*Phrase::BitbucketSyncApi* | [**bitbucket_syncs_list**](docs/BitbucketSyncApi.md#bitbucket_syncs_list) | **GET** /bitbucket_syncs | List Bitbucket syncs
|
|
143
140
|
*Phrase::BlacklistedKeysApi* | [**blacklisted_key_create**](docs/BlacklistedKeysApi.md#blacklisted_key_create) | **POST** /projects/{project_id}/blacklisted_keys | Create a blocked key
|
|
144
141
|
*Phrase::BlacklistedKeysApi* | [**blacklisted_key_delete**](docs/BlacklistedKeysApi.md#blacklisted_key_delete) | **DELETE** /projects/{project_id}/blacklisted_keys/{id} | Delete a blocked key
|
|
145
142
|
*Phrase::BlacklistedKeysApi* | [**blacklisted_key_show**](docs/BlacklistedKeysApi.md#blacklisted_key_show) | **GET** /projects/{project_id}/blacklisted_keys/{id} | Get a single blocked key
|
|
@@ -188,15 +185,6 @@ Class | Method | HTTP request | Description
|
|
|
188
185
|
*Phrase::FigmaAttachmentsApi* | [**figma_attachment_update**](docs/FigmaAttachmentsApi.md#figma_attachment_update) | **PATCH** /projects/{project_id}/figma_attachments/{id} | Update a Figma attachment
|
|
189
186
|
*Phrase::FigmaAttachmentsApi* | [**figma_attachments_list**](docs/FigmaAttachmentsApi.md#figma_attachments_list) | **GET** /projects/{project_id}/figma_attachments | List Figma attachments
|
|
190
187
|
*Phrase::FormatsApi* | [**formats_list**](docs/FormatsApi.md#formats_list) | **GET** /formats | List formats
|
|
191
|
-
*Phrase::GitHubSyncApi* | [**github_sync_export**](docs/GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase Strings to GitHub
|
|
192
|
-
*Phrase::GitHubSyncApi* | [**github_sync_import**](docs/GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase Strings from GitHub
|
|
193
|
-
*Phrase::GitLabSyncApi* | [**gitlab_sync_delete**](docs/GitLabSyncApi.md#gitlab_sync_delete) | **DELETE** /gitlab_syncs/{id} | Delete single Sync Setting
|
|
194
|
-
*Phrase::GitLabSyncApi* | [**gitlab_sync_export**](docs/GitLabSyncApi.md#gitlab_sync_export) | **POST** /gitlab_syncs/{gitlab_sync_id}/export | Export from Phrase Strings to GitLab
|
|
195
|
-
*Phrase::GitLabSyncApi* | [**gitlab_sync_history**](docs/GitLabSyncApi.md#gitlab_sync_history) | **GET** /gitlab_syncs/{gitlab_sync_id}/history | History of single Sync Setting
|
|
196
|
-
*Phrase::GitLabSyncApi* | [**gitlab_sync_import**](docs/GitLabSyncApi.md#gitlab_sync_import) | **POST** /gitlab_syncs/{gitlab_sync_id}/import | Import from GitLab to Phrase
|
|
197
|
-
*Phrase::GitLabSyncApi* | [**gitlab_sync_list**](docs/GitLabSyncApi.md#gitlab_sync_list) | **GET** /gitlab_syncs | List GitLab syncs
|
|
198
|
-
*Phrase::GitLabSyncApi* | [**gitlab_sync_show**](docs/GitLabSyncApi.md#gitlab_sync_show) | **GET** /gitlab_syncs/{id} | Get single Sync Setting
|
|
199
|
-
*Phrase::GitLabSyncApi* | [**gitlab_sync_update**](docs/GitLabSyncApi.md#gitlab_sync_update) | **PUT** /gitlab_syncs/{id} | Update single Sync Setting
|
|
200
188
|
*Phrase::GlossariesApi* | [**glossaries_list**](docs/GlossariesApi.md#glossaries_list) | **GET** /accounts/{account_id}/glossaries | List term bases
|
|
201
189
|
*Phrase::GlossariesApi* | [**glossary_create**](docs/GlossariesApi.md#glossary_create) | **POST** /accounts/{account_id}/glossaries | Create a term base
|
|
202
190
|
*Phrase::GlossariesApi* | [**glossary_delete**](docs/GlossariesApi.md#glossary_delete) | **DELETE** /accounts/{account_id}/glossaries/{id} | Delete a term base
|
|
@@ -311,7 +299,7 @@ Class | Method | HTTP request | Description
|
|
|
311
299
|
*Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
|
|
312
300
|
*Phrase::ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
|
|
313
301
|
*Phrase::ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /projects | List projects
|
|
314
|
-
*Phrase::QualityPerformanceScoreApi* | [**
|
|
302
|
+
*Phrase::QualityPerformanceScoreApi* | [**quality_performance_score_list**](docs/QualityPerformanceScoreApi.md#quality_performance_score_list) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
|
|
315
303
|
*Phrase::ReleaseTriggersApi* | [**release_triggers_create**](docs/ReleaseTriggersApi.md#release_triggers_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/release_triggers | Create a release trigger
|
|
316
304
|
*Phrase::ReleaseTriggersApi* | [**release_triggers_destroy**](docs/ReleaseTriggersApi.md#release_triggers_destroy) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} | Delete a single release trigger
|
|
317
305
|
*Phrase::ReleaseTriggersApi* | [**release_triggers_list**](docs/ReleaseTriggersApi.md#release_triggers_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/release_triggers | List release triggers
|
|
@@ -323,10 +311,10 @@ Class | Method | HTTP request | Description
|
|
|
323
311
|
*Phrase::ReleasesApi* | [**release_show**](docs/ReleasesApi.md#release_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release
|
|
324
312
|
*Phrase::ReleasesApi* | [**release_update**](docs/ReleasesApi.md#release_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release
|
|
325
313
|
*Phrase::ReleasesApi* | [**releases_list**](docs/ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
|
|
314
|
+
*Phrase::RepoSyncEventsApi* | [**repo_sync_event_list**](docs/RepoSyncEventsApi.md#repo_sync_event_list) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
|
|
315
|
+
*Phrase::RepoSyncEventsApi* | [**repo_sync_event_show**](docs/RepoSyncEventsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
|
|
326
316
|
*Phrase::RepoSyncsApi* | [**repo_sync_activate**](docs/RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync
|
|
327
317
|
*Phrase::RepoSyncsApi* | [**repo_sync_deactivate**](docs/RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync
|
|
328
|
-
*Phrase::RepoSyncsApi* | [**repo_sync_event_show**](docs/RepoSyncsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
|
|
329
|
-
*Phrase::RepoSyncsApi* | [**repo_sync_events**](docs/RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
|
|
330
318
|
*Phrase::RepoSyncsApi* | [**repo_sync_export**](docs/RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository
|
|
331
319
|
*Phrase::RepoSyncsApi* | [**repo_sync_import**](docs/RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository
|
|
332
320
|
*Phrase::RepoSyncsApi* | [**repo_sync_list**](docs/RepoSyncsApi.md#repo_sync_list) | **GET** /accounts/{account_id}/repo_syncs | Get Repo Syncs
|
|
@@ -422,10 +410,6 @@ Class | Method | HTTP request | Description
|
|
|
422
410
|
- [Phrase::AuthorizationCreateParameters](docs/AuthorizationCreateParameters.md)
|
|
423
411
|
- [Phrase::AuthorizationUpdateParameters](docs/AuthorizationUpdateParameters.md)
|
|
424
412
|
- [Phrase::AuthorizationWithToken](docs/AuthorizationWithToken.md)
|
|
425
|
-
- [Phrase::BitbucketSync](docs/BitbucketSync.md)
|
|
426
|
-
- [Phrase::BitbucketSyncExportParameters](docs/BitbucketSyncExportParameters.md)
|
|
427
|
-
- [Phrase::BitbucketSyncExportResponse](docs/BitbucketSyncExportResponse.md)
|
|
428
|
-
- [Phrase::BitbucketSyncImportParameters](docs/BitbucketSyncImportParameters.md)
|
|
429
413
|
- [Phrase::BlacklistedKey](docs/BlacklistedKey.md)
|
|
430
414
|
- [Phrase::BlacklistedKeyCreateParameters](docs/BlacklistedKeyCreateParameters.md)
|
|
431
415
|
- [Phrase::BlacklistedKeyUpdateParameters](docs/BlacklistedKeyUpdateParameters.md)
|
|
@@ -459,14 +443,6 @@ Class | Method | HTTP request | Description
|
|
|
459
443
|
- [Phrase::FigmaAttachmentCreateParameters](docs/FigmaAttachmentCreateParameters.md)
|
|
460
444
|
- [Phrase::FigmaAttachmentUpdateParameters](docs/FigmaAttachmentUpdateParameters.md)
|
|
461
445
|
- [Phrase::Format](docs/Format.md)
|
|
462
|
-
- [Phrase::GithubSyncExportParameters](docs/GithubSyncExportParameters.md)
|
|
463
|
-
- [Phrase::GithubSyncImportParameters](docs/GithubSyncImportParameters.md)
|
|
464
|
-
- [Phrase::GitlabSync](docs/GitlabSync.md)
|
|
465
|
-
- [Phrase::GitlabSyncExport](docs/GitlabSyncExport.md)
|
|
466
|
-
- [Phrase::GitlabSyncExportParameters](docs/GitlabSyncExportParameters.md)
|
|
467
|
-
- [Phrase::GitlabSyncHistory](docs/GitlabSyncHistory.md)
|
|
468
|
-
- [Phrase::GitlabSyncHistoryErrorsInner](docs/GitlabSyncHistoryErrorsInner.md)
|
|
469
|
-
- [Phrase::GitlabSyncImportParameters](docs/GitlabSyncImportParameters.md)
|
|
470
446
|
- [Phrase::Glossary](docs/Glossary.md)
|
|
471
447
|
- [Phrase::GlossaryCreateParameters](docs/GlossaryCreateParameters.md)
|
|
472
448
|
- [Phrase::GlossaryTerm](docs/GlossaryTerm.md)
|
|
@@ -490,6 +466,7 @@ Class | Method | HTTP request | Description
|
|
|
490
466
|
- [Phrase::JobCreateParameters](docs/JobCreateParameters.md)
|
|
491
467
|
- [Phrase::JobDetails](docs/JobDetails.md)
|
|
492
468
|
- [Phrase::JobKeysCreateParameters](docs/JobKeysCreateParameters.md)
|
|
469
|
+
- [Phrase::JobKeysDeleteParameters](docs/JobKeysDeleteParameters.md)
|
|
493
470
|
- [Phrase::JobLocale](docs/JobLocale.md)
|
|
494
471
|
- [Phrase::JobLocaleCompleteParameters](docs/JobLocaleCompleteParameters.md)
|
|
495
472
|
- [Phrase::JobLocaleCompleteReviewParameters](docs/JobLocaleCompleteReviewParameters.md)
|
|
@@ -558,12 +535,12 @@ Class | Method | HTTP request | Description
|
|
|
558
535
|
- [Phrase::ProjectReport](docs/ProjectReport.md)
|
|
559
536
|
- [Phrase::ProjectShort](docs/ProjectShort.md)
|
|
560
537
|
- [Phrase::ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
|
|
561
|
-
- [Phrase::
|
|
562
|
-
- [Phrase::
|
|
563
|
-
- [Phrase::
|
|
564
|
-
- [Phrase::
|
|
565
|
-
- [Phrase::
|
|
566
|
-
- [Phrase::
|
|
538
|
+
- [Phrase::QualityPerformanceScoreList200Response](docs/QualityPerformanceScoreList200Response.md)
|
|
539
|
+
- [Phrase::QualityPerformanceScoreList200ResponseAnyOf](docs/QualityPerformanceScoreList200ResponseAnyOf.md)
|
|
540
|
+
- [Phrase::QualityPerformanceScoreList200ResponseAnyOfData](docs/QualityPerformanceScoreList200ResponseAnyOfData.md)
|
|
541
|
+
- [Phrase::QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner](docs/QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner.md)
|
|
542
|
+
- [Phrase::QualityPerformanceScoreList200ResponseAnyOfErrorsInner](docs/QualityPerformanceScoreList200ResponseAnyOfErrorsInner.md)
|
|
543
|
+
- [Phrase::QualityPerformanceScoreListRequest](docs/QualityPerformanceScoreListRequest.md)
|
|
567
544
|
- [Phrase::Release](docs/Release.md)
|
|
568
545
|
- [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
|
|
569
546
|
- [Phrase::ReleaseCreateParameters1](docs/ReleaseCreateParameters1.md)
|
|
@@ -574,7 +551,6 @@ Class | Method | HTTP request | Description
|
|
|
574
551
|
- [Phrase::RepliesListParameters](docs/RepliesListParameters.md)
|
|
575
552
|
- [Phrase::RepoSync](docs/RepoSync.md)
|
|
576
553
|
- [Phrase::RepoSyncEvent](docs/RepoSyncEvent.md)
|
|
577
|
-
- [Phrase::RepoSyncEventErrorsInner](docs/RepoSyncEventErrorsInner.md)
|
|
578
554
|
- [Phrase::Screenshot](docs/Screenshot.md)
|
|
579
555
|
- [Phrase::ScreenshotMarker](docs/ScreenshotMarker.md)
|
|
580
556
|
- [Phrase::ScreenshotMarkerCreateParameters](docs/ScreenshotMarkerCreateParameters.md)
|
|
@@ -5,13 +5,15 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**message** | **String** | Job comment message | [optional]
|
|
8
|
+
**branch** | **String** | Branch name for the job | [optional]
|
|
8
9
|
|
|
9
10
|
## Code Sample
|
|
10
11
|
|
|
11
12
|
```ruby
|
|
12
13
|
require 'Phrase'
|
|
13
14
|
|
|
14
|
-
instance = Phrase::JobCommentCreateParameters.new(message: Some message
|
|
15
|
+
instance = Phrase::JobCommentCreateParameters.new(message: Some message...,
|
|
16
|
+
branch: my-feature-branch)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
|
|
@@ -5,13 +5,15 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**message** | **String** | Comment message | [optional]
|
|
8
|
+
**branch** | **String** | Branch name for the job | [optional]
|
|
8
9
|
|
|
9
10
|
## Code Sample
|
|
10
11
|
|
|
11
12
|
```ruby
|
|
12
13
|
require 'Phrase'
|
|
13
14
|
|
|
14
|
-
instance = Phrase::JobCommentUpdateParameters.new(message: Some message
|
|
15
|
+
instance = Phrase::JobCommentUpdateParameters.new(message: Some message...,
|
|
16
|
+
branch: my-feature-branch)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
|
data/docs/JobCommentsApi.md
CHANGED
|
@@ -107,7 +107,7 @@ job_id = 'job_id_example' # String | Job ID
|
|
|
107
107
|
id = 'id_example' # String | ID
|
|
108
108
|
opts = {
|
|
109
109
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
110
|
-
branch: 'my-feature-branch' # String |
|
|
110
|
+
branch: 'my-feature-branch' # String | Branch to use
|
|
111
111
|
}
|
|
112
112
|
|
|
113
113
|
begin
|
|
@@ -127,7 +127,7 @@ Name | Type | Description | Notes
|
|
|
127
127
|
**job_id** | **String**| Job ID |
|
|
128
128
|
**id** | **String**| ID |
|
|
129
129
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
130
|
-
**branch** | **String**|
|
|
130
|
+
**branch** | **String**| Branch to use | [optional]
|
|
131
131
|
|
|
132
132
|
### Return type
|
|
133
133
|
|
|
@@ -173,7 +173,7 @@ job_id = 'job_id_example' # String | Job ID
|
|
|
173
173
|
id = 'id_example' # String | ID
|
|
174
174
|
opts = {
|
|
175
175
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
176
|
-
branch: 'my-feature-branch' # String |
|
|
176
|
+
branch: 'my-feature-branch' # String | Branch to use
|
|
177
177
|
}
|
|
178
178
|
|
|
179
179
|
begin
|
|
@@ -194,7 +194,7 @@ Name | Type | Description | Notes
|
|
|
194
194
|
**job_id** | **String**| Job ID |
|
|
195
195
|
**id** | **String**| ID |
|
|
196
196
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
197
|
-
**branch** | **String**|
|
|
197
|
+
**branch** | **String**| Branch to use | [optional]
|
|
198
198
|
|
|
199
199
|
### Return type
|
|
200
200
|
|
|
@@ -306,7 +306,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
306
306
|
job_id = 'job_id_example' # String | Job ID
|
|
307
307
|
opts = {
|
|
308
308
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
309
|
-
branch: 'my-feature-branch', # String |
|
|
309
|
+
branch: 'my-feature-branch', # String | Branch to use
|
|
310
310
|
order: 'desc' # String | Order direction. Can be one of: asc, desc.
|
|
311
311
|
}
|
|
312
312
|
|
|
@@ -327,7 +327,7 @@ Name | Type | Description | Notes
|
|
|
327
327
|
**project_id** | **String**| Project ID |
|
|
328
328
|
**job_id** | **String**| Job ID |
|
|
329
329
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
330
|
-
**branch** | **String**|
|
|
330
|
+
**branch** | **String**| Branch to use | [optional]
|
|
331
331
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
332
332
|
|
|
333
333
|
### Return type
|
data/docs/JobDetails.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**updated_at** | **Time** | | [optional]
|
|
17
17
|
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
18
18
|
**job_tag_name** | **String** | | [optional]
|
|
19
|
+
**source_translations_updated_at** | **Time** | | [optional]
|
|
19
20
|
**source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
20
21
|
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
21
22
|
**keys** | [**Array<KeyPreview>**](KeyPreview.md) | | [optional]
|
|
@@ -37,6 +38,7 @@ instance = Phrase::JobDetails.new(id: null,
|
|
|
37
38
|
updated_at: null,
|
|
38
39
|
owner: null,
|
|
39
40
|
job_tag_name: null,
|
|
41
|
+
source_translations_updated_at: null,
|
|
40
42
|
source_locale: null,
|
|
41
43
|
locales: null,
|
|
42
44
|
keys: null)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Phrase::JobKeysDeleteParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
+
**translation_key_ids** | **Array<String>** | ids of keys that should be deleted from the job |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'Phrase'
|
|
14
|
+
|
|
15
|
+
instance = Phrase::JobKeysDeleteParameters.new(branch: my-feature-branch,
|
|
16
|
+
translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/JobLocalesApi.md
CHANGED
|
@@ -179,7 +179,7 @@ job_id = 'job_id_example' # String | Job ID
|
|
|
179
179
|
id = 'id_example' # String | ID
|
|
180
180
|
opts = {
|
|
181
181
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
182
|
-
branch: 'my-feature-branch' # String |
|
|
182
|
+
branch: 'my-feature-branch' # String | Branch to use
|
|
183
183
|
}
|
|
184
184
|
|
|
185
185
|
begin
|
|
@@ -199,7 +199,7 @@ Name | Type | Description | Notes
|
|
|
199
199
|
**job_id** | **String**| Job ID |
|
|
200
200
|
**id** | **String**| ID |
|
|
201
201
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
202
|
-
**branch** | **String**|
|
|
202
|
+
**branch** | **String**| Branch to use | [optional]
|
|
203
203
|
|
|
204
204
|
### Return type
|
|
205
205
|
|
|
@@ -312,7 +312,7 @@ job_id = 'job_id_example' # String | Job ID
|
|
|
312
312
|
id = 'id_example' # String | ID
|
|
313
313
|
opts = {
|
|
314
314
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
315
|
-
branch: 'my-feature-branch' # String |
|
|
315
|
+
branch: 'my-feature-branch' # String | Branch to use
|
|
316
316
|
}
|
|
317
317
|
|
|
318
318
|
begin
|
|
@@ -333,7 +333,7 @@ Name | Type | Description | Notes
|
|
|
333
333
|
**job_id** | **String**| Job ID |
|
|
334
334
|
**id** | **String**| ID |
|
|
335
335
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
336
|
-
**branch** | **String**|
|
|
336
|
+
**branch** | **String**| Branch to use | [optional]
|
|
337
337
|
|
|
338
338
|
### Return type
|
|
339
339
|
|
|
@@ -512,7 +512,7 @@ opts = {
|
|
|
512
512
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
513
513
|
page: 1, # Integer | Page number
|
|
514
514
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
515
|
-
branch: 'my-feature-branch' # String |
|
|
515
|
+
branch: 'my-feature-branch' # String | Branch to use
|
|
516
516
|
}
|
|
517
517
|
|
|
518
518
|
begin
|
|
@@ -534,7 +534,7 @@ Name | Type | Description | Notes
|
|
|
534
534
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
535
535
|
**page** | **Integer**| Page number | [optional]
|
|
536
536
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
537
|
-
**branch** | **String**|
|
|
537
|
+
**branch** | **String**| Branch to use | [optional]
|
|
538
538
|
|
|
539
539
|
### Return type
|
|
540
540
|
|
data/docs/JobsApi.md
CHANGED
|
@@ -279,7 +279,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
279
279
|
|
|
280
280
|
## job_keys_delete
|
|
281
281
|
|
|
282
|
-
> job_keys_delete(project_id, id, opts)
|
|
282
|
+
> job_keys_delete(project_id, id, job_keys_delete_parameters, opts)
|
|
283
283
|
|
|
284
284
|
Remove keys from job
|
|
285
285
|
|
|
@@ -304,15 +304,14 @@ end
|
|
|
304
304
|
api_instance = Phrase::JobsApi.new
|
|
305
305
|
project_id = 'project_id_example' # String | Project ID
|
|
306
306
|
id = 'id_example' # String | ID
|
|
307
|
+
job_keys_delete_parameters = Phrase::JobKeysDeleteParameters.new({translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"]}) # JobKeysDeleteParameters |
|
|
307
308
|
opts = {
|
|
308
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example'
|
|
309
|
-
branch: 'my-feature-branch', # String | specify the branch to use
|
|
310
|
-
translation_key_ids: ['inner_example'] # Array<String> | ids of keys that should be removed from the job
|
|
309
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
311
310
|
}
|
|
312
311
|
|
|
313
312
|
begin
|
|
314
313
|
#Remove keys from job
|
|
315
|
-
api_instance.job_keys_delete(project_id, id, opts)
|
|
314
|
+
api_instance.job_keys_delete(project_id, id, job_keys_delete_parameters, opts)
|
|
316
315
|
rescue Phrase::ApiError => e
|
|
317
316
|
puts "Exception when calling JobsApi->job_keys_delete: #{e}"
|
|
318
317
|
end
|
|
@@ -325,9 +324,8 @@ Name | Type | Description | Notes
|
|
|
325
324
|
------------- | ------------- | ------------- | -------------
|
|
326
325
|
**project_id** | **String**| Project ID |
|
|
327
326
|
**id** | **String**| ID |
|
|
327
|
+
**job_keys_delete_parameters** | [**JobKeysDeleteParameters**](JobKeysDeleteParameters.md)| |
|
|
328
328
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
329
|
-
**branch** | **String**| specify the branch to use | [optional]
|
|
330
|
-
**translation_key_ids** | [**Array<String>**](String.md)| ids of keys that should be removed from the job | [optional]
|
|
331
329
|
|
|
332
330
|
### Return type
|
|
333
331
|
|
|
@@ -339,7 +337,7 @@ Response<(nil (empty response body))>
|
|
|
339
337
|
|
|
340
338
|
### HTTP request headers
|
|
341
339
|
|
|
342
|
-
- **Content-Type**:
|
|
340
|
+
- **Content-Type**: application/json
|
|
343
341
|
- **Accept**: Not defined
|
|
344
342
|
|
|
345
343
|
|
|
@@ -763,7 +761,8 @@ opts = {
|
|
|
763
761
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
764
762
|
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
|
765
763
|
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
|
766
|
-
state: 'completed' # String | filter by state of job
|
|
764
|
+
state: 'completed', # String | filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
|
765
|
+
updated_since: '2013-02-21T00:00:00.000Z' # String | filter by jobs updated since given date
|
|
767
766
|
}
|
|
768
767
|
|
|
769
768
|
begin
|
|
@@ -786,7 +785,8 @@ Name | Type | Description | Notes
|
|
|
786
785
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
787
786
|
**owned_by** | **String**| filter by user owning job | [optional]
|
|
788
787
|
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
|
789
|
-
**state** | **String**| filter by state of job
|
|
788
|
+
**state** | **String**| filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code> | [optional]
|
|
789
|
+
**updated_since** | **String**| filter by jobs updated since given date | [optional]
|
|
790
790
|
|
|
791
791
|
### Return type
|
|
792
792
|
|
|
@@ -832,10 +832,11 @@ opts = {
|
|
|
832
832
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
833
833
|
page: 1, # Integer | Page number
|
|
834
834
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
835
|
-
branch: 'my-feature-branch', # String |
|
|
835
|
+
branch: 'my-feature-branch', # String | Branch to use
|
|
836
836
|
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
|
837
837
|
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
|
838
|
-
state: 'completed' # String | filter by state of job
|
|
838
|
+
state: 'completed', # String | filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
|
839
|
+
updated_since: '2013-02-21T00:00:00.000Z' # String | filter by jobs updated since given date
|
|
839
840
|
}
|
|
840
841
|
|
|
841
842
|
begin
|
|
@@ -856,10 +857,11 @@ Name | Type | Description | Notes
|
|
|
856
857
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
857
858
|
**page** | **Integer**| Page number | [optional]
|
|
858
859
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
859
|
-
**branch** | **String**|
|
|
860
|
+
**branch** | **String**| Branch to use | [optional]
|
|
860
861
|
**owned_by** | **String**| filter by user owning job | [optional]
|
|
861
862
|
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
|
862
|
-
**state** | **String**| filter by state of job
|
|
863
|
+
**state** | **String**| filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code> | [optional]
|
|
864
|
+
**updated_since** | **String**| filter by jobs updated since given date | [optional]
|
|
863
865
|
|
|
864
866
|
### Return type
|
|
865
867
|
|
data/docs/KeyCreateParameters.md
CHANGED
|
@@ -36,7 +36,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
|
|
|
36
36
|
data_type: number,
|
|
37
37
|
tags: awesome-feature,needs-proofreading,
|
|
38
38
|
max_characters_allowed: 140,
|
|
39
|
-
screenshot: [B@
|
|
39
|
+
screenshot: [B@168b28ef,
|
|
40
40
|
remove_screenshot: null,
|
|
41
41
|
unformatted: null,
|
|
42
42
|
default_translation_content: Default translation content,
|
data/docs/KeyUpdateParameters.md
CHANGED
|
@@ -34,7 +34,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
|
|
|
34
34
|
data_type: number,
|
|
35
35
|
tags: awesome-feature,needs-proofreading,
|
|
36
36
|
max_characters_allowed: 140,
|
|
37
|
-
screenshot: [B@
|
|
37
|
+
screenshot: [B@e8fabad,
|
|
38
38
|
remove_screenshot: null,
|
|
39
39
|
unformatted: null,
|
|
40
40
|
xml_space_preserve: null,
|
data/docs/KeysApi.md
CHANGED
|
@@ -304,7 +304,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
304
304
|
opts = {
|
|
305
305
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
306
306
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
307
|
-
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id
|
|
307
|
+
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
|
308
308
|
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
|
309
309
|
}
|
|
310
310
|
|
|
@@ -325,7 +325,7 @@ Name | Type | Description | Notes
|
|
|
325
325
|
**project_id** | **String**| Project ID |
|
|
326
326
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
327
327
|
**branch** | **String**| specify the branch to use | [optional]
|
|
328
|
-
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id
|
|
328
|
+
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
329
329
|
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
330
330
|
|
|
331
331
|
### Return type
|
|
@@ -501,7 +501,7 @@ opts = {
|
|
|
501
501
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
502
502
|
sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
|
|
503
503
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
504
|
-
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name
|
|
504
|
+
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
|
505
505
|
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
|
506
506
|
}
|
|
507
507
|
|
|
@@ -526,7 +526,7 @@ Name | Type | Description | Notes
|
|
|
526
526
|
**branch** | **String**| specify the branch to use | [optional]
|
|
527
527
|
**sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
|
528
528
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
529
|
-
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name
|
|
529
|
+
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
530
530
|
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
531
531
|
|
|
532
532
|
### Return type
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id
|
|
8
|
+
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
9
9
|
**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id
|
|
8
|
+
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
9
9
|
**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
|
|
11
11
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
|
9
9
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
10
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li> <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li> <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id
|
|
10
|
+
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li> <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li> <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
|
|
11
11
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|