phrase 4.31.0 → 4.33.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 +21 -0
- data/Gemfile +1 -1
- data/README.md +4 -3
- data/docs/CustomMetadataPropertiesUpdateParameters.md +1 -1
- data/docs/Glossary.md +2 -0
- data/docs/GlossaryTermUpdateParameters.md +1 -1
- data/docs/JobCreateParameters.md +4 -2
- data/docs/JobDetails.md +3 -1
- data/docs/JobTemplateCreateParameters.md +2 -0
- data/docs/JobTemplateDetails.md +3 -1
- data/docs/JobTemplateUpdateParameters.md +3 -1
- data/docs/JobUpdateParameters.md +5 -3
- data/docs/KeyUpdateParameters.md +5 -5
- data/docs/LocaleUpdateParameters.md +2 -2
- data/docs/OrganizationJobTemplateCreateParameters.md +2 -0
- data/docs/OrganizationJobTemplateDetails.md +3 -1
- data/docs/OrganizationJobTemplateUpdateParameters.md +3 -1
- data/docs/ProjectUpdateParameters.md +1 -1
- data/docs/ReleaseUpdateParameters.md +3 -3
- data/docs/RepoSyncEvent.md +3 -1
- data/docs/RepoSyncEventUploadsInner.md +19 -0
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/StyleguideUpdateParameters.md +9 -9
- data/docs/TranslationUpdateParameters.md +1 -1
- data/docs/TranslationsApi.md +7 -7
- data/docs/TranslationsExcludeParameters.md +2 -2
- data/docs/TranslationsIncludeParameters.md +2 -2
- data/docs/TranslationsReviewParameters.md +2 -2
- data/docs/TranslationsSearchParameters.md +2 -2
- data/docs/TranslationsUnreviewParameters.md +2 -2
- data/docs/TranslationsUnverifyParameters.md +2 -2
- data/docs/TranslationsVerifyParameters.md +2 -2
- data/docs/WebhookUpdateParameters.md +1 -1
- data/lib/phrase/api/translations_api.rb +8 -8
- data/lib/phrase/models/custom_metadata_properties_update_parameters.rb +2 -1
- data/lib/phrase/models/glossary.rb +11 -1
- data/lib/phrase/models/glossary_term_update_parameters.rb +2 -1
- data/lib/phrase/models/job_create_parameters.rb +15 -5
- data/lib/phrase/models/job_details.rb +14 -4
- data/lib/phrase/models/job_template_create_parameters.rb +11 -1
- data/lib/phrase/models/job_template_details.rb +14 -4
- data/lib/phrase/models/job_template_update_parameters.rb +13 -2
- data/lib/phrase/models/job_update_parameters.rb +18 -6
- data/lib/phrase/models/key_update_parameters.rb +10 -5
- data/lib/phrase/models/locale_update_parameters.rb +4 -2
- data/lib/phrase/models/organization_job_template_create_parameters.rb +11 -1
- data/lib/phrase/models/organization_job_template_details.rb +14 -4
- data/lib/phrase/models/organization_job_template_update_parameters.rb +13 -2
- data/lib/phrase/models/project_update_parameters.rb +2 -1
- data/lib/phrase/models/release_update_parameters.rb +6 -3
- data/lib/phrase/models/repo_sync_event.rb +17 -4
- data/lib/phrase/models/repo_sync_event_uploads_inner.rb +241 -0
- data/lib/phrase/models/screenshot_update_parameters.rb +2 -1
- data/lib/phrase/models/styleguide_update_parameters.rb +18 -9
- data/lib/phrase/models/translation_update_parameters.rb +2 -1
- data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
- data/lib/phrase/models/translations_include_parameters.rb +1 -1
- data/lib/phrase/models/translations_review_parameters.rb +1 -1
- data/lib/phrase/models/translations_search_parameters.rb +1 -1
- data/lib/phrase/models/translations_unreview_parameters.rb +1 -1
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/models/webhook_update_parameters.rb +2 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +1 -0
- data/spec/api/translations_api_spec.rb +4 -4
- data/spec/models/glossary_spec.rb +6 -0
- data/spec/models/job_create_parameters_spec.rb +6 -0
- data/spec/models/job_details_spec.rb +6 -0
- data/spec/models/job_template_create_parameters_spec.rb +6 -0
- data/spec/models/job_template_details_spec.rb +6 -0
- data/spec/models/job_template_update_parameters_spec.rb +6 -0
- data/spec/models/job_update_parameters_spec.rb +6 -0
- data/spec/models/organization_job_template_create_parameters_spec.rb +6 -0
- data/spec/models/organization_job_template_details_spec.rb +6 -0
- data/spec/models/organization_job_template_update_parameters_spec.rb +6 -0
- data/spec/models/repo_sync_event_spec.rb +6 -0
- data/spec/models/repo_sync_event_uploads_inner_spec.rb +39 -0
- metadata +276 -272
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cb68f3e7de65794408fd8af7a561ef3b36a2e2220a6d3e1fb1b70ad12b10ddda
|
|
4
|
+
data.tar.gz: 9c0223415b68d524ccc0583496b23351d6caaedb44f1cccd04e5088eff221ec4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '08ba82de28c3449d6abd1db15b585667c0fffb054a230a351a8dcd5c8073617ab4c2d7315ca8bf2ed4a7acf8fb6e02ee736631bbb07806e1e1643371e875857c'
|
|
7
|
+
data.tar.gz: 24c734ba8c05035c02b10128f73ced9d4c442df9ac09d5184097cf66076095a202f1c3d9eb8d797286c0960e9ad213cc7931344ff1424ac801e7c22463652623
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.33.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.32.0...ruby-v4.33.0) (2026-11-04)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **API:** add exclude_linked_child_keys to jobs and job templates #STRINGS-4424 ([#1356](https://github.com/phrase/strings-openapi/issues/1356)) ([46690ee](https://github.com/phrase/strings-openapi/commit/46690ee15758d6d500aa5eec5e264f1686f50200))
|
|
9
|
+
* **API:** add uploads array to repo sync import event show response #STRINGS-3739 ([#1342](https://github.com/phrase/strings-openapi/issues/1342)) ([b5a07de](https://github.com/phrase/strings-openapi/commit/b5a07decfa83958869e9ce9363d45646cc8fa523))
|
|
10
|
+
|
|
11
|
+
## [4.32.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.31.0...ruby-v4.32.0) (2026-10-22)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* **API:** add terms_count field to glossary responses #STRINGS-3924 ([#1334](https://github.com/phrase/strings-openapi/issues/1334)) ([9eab4dc](https://github.com/phrase/strings-openapi/commit/9eab4dcc28074b581934d603ec6f653efe100d72))
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* **API:** make clearable string fields on update endpoints nullable #STRINGS-3652 ([#1326](https://github.com/phrase/strings-openapi/issues/1326)) ([3eb4b6f](https://github.com/phrase/strings-openapi/commit/3eb4b6fe2481f5ad199ae5e3c88eaecabc4d62da))
|
|
22
|
+
* **API:** make translation content and key description nullable #STRINGS-3652 ([#1325](https://github.com/phrase/strings-openapi/issues/1325)) ([2f18702](https://github.com/phrase/strings-openapi/commit/2f1870215d4c84a382ab3cfa76dd9f922dad5903))
|
|
23
|
+
|
|
3
24
|
## [4.31.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.30.1...ruby-v4.31.0) (2026-10-22)
|
|
4
25
|
|
|
5
26
|
|
data/Gemfile
CHANGED
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: 4.
|
|
10
|
+
- Package version: 4.33.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-4.
|
|
59
|
+
gem install ./phrase-4.33.0.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./phrase-4.
|
|
62
|
+
(for development, run `gem install --dev ./phrase-4.33.0.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
## Getting Started
|
|
65
65
|
|
|
@@ -608,6 +608,7 @@ Class | Method | HTTP request | Description
|
|
|
608
608
|
- [Phrase::RepoSync](docs/RepoSync.md)
|
|
609
609
|
- [Phrase::RepoSyncCreateParameters](docs/RepoSyncCreateParameters.md)
|
|
610
610
|
- [Phrase::RepoSyncEvent](docs/RepoSyncEvent.md)
|
|
611
|
+
- [Phrase::RepoSyncEventUploadsInner](docs/RepoSyncEventUploadsInner.md)
|
|
611
612
|
- [Phrase::RepoSyncExportParameters](docs/RepoSyncExportParameters.md)
|
|
612
613
|
- [Phrase::RepoSyncImportParameters](docs/RepoSyncImportParameters.md)
|
|
613
614
|
- [Phrase::Screenshot](docs/Screenshot.md)
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | name of the property | [optional]
|
|
8
8
|
**project_ids** | **Array<String>** | ids of projects that the property belongs to | [optional]
|
|
9
|
-
**description** | **String** | description of property | [optional]
|
|
9
|
+
**description** | **String** | description of property. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
10
10
|
**value_options** | **Array<String>** | value options of property (only applies to single or multi select properties) | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
data/docs/Glossary.md
CHANGED
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **String** | | [optional]
|
|
8
8
|
**name** | **String** | | [optional]
|
|
9
|
+
**terms_count** | **Integer** | Number of terms in the glossary. | [optional]
|
|
9
10
|
**projects** | [**Array<ProjectShort>**](ProjectShort.md) | | [optional]
|
|
10
11
|
**spaces** | [**Array<Space>**](Space.md) | | [optional]
|
|
11
12
|
**created_at** | **Time** | | [optional]
|
|
@@ -18,6 +19,7 @@ require 'phrase'
|
|
|
18
19
|
|
|
19
20
|
instance = Phrase::Glossary.new(id: nil,
|
|
20
21
|
name: nil,
|
|
22
|
+
terms_count: 42,
|
|
21
23
|
projects: nil,
|
|
22
24
|
spaces: nil,
|
|
23
25
|
created_at: nil,
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**term** | **String** | Glossary term | [optional]
|
|
8
|
-
**description** | **String** | Description of term | [optional]
|
|
8
|
+
**description** | **String** | Description of term. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
9
9
|
**translatable** | **Boolean** | Indicates whether the term should be used for all languages or can be translated | [optional]
|
|
10
10
|
**case_sensitive** | **Boolean** | Indicates whether the term is case sensitive | [optional]
|
|
11
11
|
|
data/docs/JobCreateParameters.md
CHANGED
|
@@ -14,8 +14,9 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**tags** | **Array<String>** | tags of keys that should be included within the job. *Note: a tag matches every key currently carrying that tag, not just the ones you just tagged. For example, if hundreds of pre-existing keys already share the tag `myUploadTag`, adding it here pulls in every one of them, not only the key you just tagged. Use `translation_key_ids` to scope the job to specific keys instead.* | [optional]
|
|
15
15
|
**translation_key_ids** | **Array<String>** | ids of keys that should be included within the job | [optional]
|
|
16
16
|
**target_locale_ids** | **Array<String>** | List of target locales for the job. Mutually exclusive with `job_template_id`. | [optional]
|
|
17
|
-
**job_template_id** | **String** | id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. Mutually exclusive with `target_locale_ids`. | [optional]
|
|
17
|
+
**job_template_id** | **String** | id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. Mutually exclusive with `target_locale_ids`. The calling user must have read access to the template; if the template exists but is not accessible, the request returns 404. | [optional]
|
|
18
18
|
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
19
|
+
**exclude_linked_child_keys** | **Boolean** | Exclude linked child keys from the job. While enabled, linked child keys cannot be added to the job. Defaults to `false`. | [optional]
|
|
19
20
|
|
|
20
21
|
## Code Sample
|
|
21
22
|
|
|
@@ -33,7 +34,8 @@ instance = Phrase::JobCreateParameters.new(branch: 'my-feature-branch',
|
|
|
33
34
|
translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
34
35
|
target_locale_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
35
36
|
job_template_id: 'abcd1234cdef1234abcd1234cdef1234',
|
|
36
|
-
autotranslate: true
|
|
37
|
+
autotranslate: true,
|
|
38
|
+
exclude_linked_child_keys: false)
|
|
37
39
|
```
|
|
38
40
|
|
|
39
41
|
|
data/docs/JobDetails.md
CHANGED
|
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**keys** | [**Array<KeyPreview>**](KeyPreview.md) | | [optional]
|
|
26
26
|
**annotations** | [**Array<JobAnnotationShort>**](JobAnnotationShort.md) | Returned only when `include_annotations=true` is supplied on the request. | [optional]
|
|
27
27
|
**locked** | **Boolean** | `true` if the job has been locked by the project's job-locking workflow (translations attached to the job are read-only until the job advances). | [optional]
|
|
28
|
+
**exclude_linked_child_keys** | **Boolean** | `true` if linked child keys are excluded from this job. While enabled, linked child keys cannot be added to the job. | [optional]
|
|
28
29
|
|
|
29
30
|
## Code Sample
|
|
30
31
|
|
|
@@ -51,7 +52,8 @@ instance = Phrase::JobDetails.new(id: nil,
|
|
|
51
52
|
locales: nil,
|
|
52
53
|
keys: nil,
|
|
53
54
|
annotations: nil,
|
|
54
|
-
locked: nil
|
|
55
|
+
locked: nil,
|
|
56
|
+
exclude_linked_child_keys: false)
|
|
55
57
|
```
|
|
56
58
|
|
|
57
59
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Job template name |
|
|
9
9
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
10
10
|
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
11
|
+
**exclude_linked_child_keys** | **Boolean** | Exclude linked child keys from jobs created from this template. Defaults to `false`. | [optional]
|
|
11
12
|
**source_locale_id** | **String** | The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used. | [optional]
|
|
12
13
|
**owner_id** | **String** | Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as owner at job-creation time. | [optional]
|
|
13
14
|
|
|
@@ -20,6 +21,7 @@ instance = Phrase::JobTemplateCreateParameters.new(branch: 'my-feature-branch',
|
|
|
20
21
|
name: 'template',
|
|
21
22
|
briefing: 'text',
|
|
22
23
|
autotranslate: true,
|
|
24
|
+
exclude_linked_child_keys: false,
|
|
23
25
|
source_locale_id: 'abcd1234cdef1234abcd1234cdef1234',
|
|
24
26
|
owner_id: nil)
|
|
25
27
|
```
|
data/docs/JobTemplateDetails.md
CHANGED
|
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
16
16
|
**creator** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
17
17
|
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
18
|
+
**exclude_linked_child_keys** | **Boolean** | `true` if jobs created from this template exclude linked child keys. | [optional]
|
|
18
19
|
|
|
19
20
|
## Code Sample
|
|
20
21
|
|
|
@@ -31,7 +32,8 @@ instance = Phrase::JobTemplateDetails.new(id: nil,
|
|
|
31
32
|
updated_at: nil,
|
|
32
33
|
owner: nil,
|
|
33
34
|
creator: nil,
|
|
34
|
-
locales: nil
|
|
35
|
+
locales: nil,
|
|
36
|
+
exclude_linked_child_keys: false)
|
|
35
37
|
```
|
|
36
38
|
|
|
37
39
|
|
|
@@ -6,8 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**name** | **String** | Job template name |
|
|
9
|
-
**briefing** | **String** | Briefing for the translators | [optional]
|
|
9
|
+
**briefing** | **String** | Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
10
10
|
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
11
|
+
**exclude_linked_child_keys** | **Boolean** | Exclude linked child keys from jobs created from this template. | [optional]
|
|
11
12
|
**source_locale_id** | **String** | The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used. | [optional]
|
|
12
13
|
**owner_id** | **String** | Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. Pass an empty string to clear a previously set owner; when blank, jobs created from this template will default to assigning the job creator as owner. | [optional]
|
|
13
14
|
|
|
@@ -20,6 +21,7 @@ instance = Phrase::JobTemplateUpdateParameters.new(branch: 'my-feature-branch',
|
|
|
20
21
|
name: 'template',
|
|
21
22
|
briefing: 'text',
|
|
22
23
|
autotranslate: true,
|
|
24
|
+
exclude_linked_child_keys: false,
|
|
23
25
|
source_locale_id: 'abcd1234cdef1234abcd1234cdef1234',
|
|
24
26
|
owner_id: nil)
|
|
25
27
|
```
|
data/docs/JobUpdateParameters.md
CHANGED
|
@@ -5,12 +5,13 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Job name | [optional]
|
|
8
|
-
**briefing** | **String** | Briefing for the translators | [optional]
|
|
8
|
+
**briefing** | **String** | Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
9
9
|
**due_date** | **Time** | Date the job should be finished | [optional]
|
|
10
10
|
**review_due_date** | **Time** | Date the review of the job should be finished. Must not be before `due_date`. | [optional]
|
|
11
|
-
**ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional]
|
|
11
|
+
**ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
12
12
|
**target_locale_ids** | **Array<String>** | List of target locales for the job. | [optional]
|
|
13
13
|
**autotranslate** | **Boolean** | Automatically translate the job using machine translation | [optional]
|
|
14
|
+
**exclude_linked_child_keys** | **Boolean** | Exclude linked child keys from the job. When set to `true`, linked child keys already in the job are removed and none can be added while the option is enabled. | [optional]
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -23,7 +24,8 @@ instance = Phrase::JobUpdateParameters.new(name: 'de',
|
|
|
23
24
|
review_due_date: nil,
|
|
24
25
|
ticket_url: 'https://example.atlassian.net/browse/FOO',
|
|
25
26
|
target_locale_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
26
|
-
autotranslate: true
|
|
27
|
+
autotranslate: true,
|
|
28
|
+
exclude_linked_child_keys: false)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
|
data/docs/KeyUpdateParameters.md
CHANGED
|
@@ -6,10 +6,10 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**name** | **String** | Key name | [optional]
|
|
9
|
-
**description** | **String** | Key description (usually includes contextual information for translators) | [optional]
|
|
9
|
+
**description** | **String** | Key description (usually includes contextual information for translators). Send an empty string or `null` to clear the description; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
10
10
|
**plural** | **Boolean** | Indicates whether key supports pluralization | [optional]
|
|
11
11
|
**use_ordinal_rules** | **Boolean** | Indicates whether key uses ordinal rules for pluralization | [optional]
|
|
12
|
-
**name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
|
|
12
|
+
**name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
13
13
|
**data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional]
|
|
14
14
|
**tags** | **String** | List of tags separated by comma to be associated with the key. | [optional]
|
|
15
15
|
**max_characters_allowed** | **Integer** | Max. number of characters translations for this key can have. | [optional]
|
|
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**remove_screenshot** | **Boolean** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
|
|
18
18
|
**unformatted** | **Boolean** | Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats. | [optional]
|
|
19
19
|
**xml_space_preserve** | **Boolean** | Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats. | [optional]
|
|
20
|
-
**original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
|
|
21
|
-
**localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
|
|
22
|
-
**localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
|
|
20
|
+
**original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
21
|
+
**localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
22
|
+
**localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
23
23
|
**custom_metadata** | **Object** | Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value. | [optional]
|
|
24
24
|
**excluded_in_locales** | **Array<String>** | Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions. | [optional]
|
|
25
25
|
**format_value_type** | **String** | Override of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources. | [optional]
|
|
@@ -11,12 +11,12 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the [Verification System](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
|
12
12
|
**rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
|
|
13
13
|
**source_locale_id** | **String** | Source locale. Can be the name or id of the locale. Preferred is id. | [optional]
|
|
14
|
-
**fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional]
|
|
14
|
+
**fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
15
15
|
**unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
|
16
16
|
**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
|
17
17
|
**unverify_on_source_changes** | **Boolean** | Indicates that translations for this locale should be marked as unverified when the source language has been changed. | [optional]
|
|
18
18
|
**autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional]
|
|
19
|
-
**language_ai_profile** | **String** | Identifier of the Language AI profile to use for this locale. | [optional]
|
|
19
|
+
**language_ai_profile** | **String** | Identifier of the Language AI profile to use for this locale. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
20
20
|
|
|
21
21
|
## Code Sample
|
|
22
22
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | Job template name |
|
|
8
8
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
9
9
|
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
10
|
+
**exclude_linked_child_keys** | **Boolean** | Exclude linked child keys from jobs created from this template. Defaults to `false`. | [optional]
|
|
10
11
|
**owner_id** | **String** | Code of the account member to set as the job template owner. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as its owner at job-creation time. | [optional]
|
|
11
12
|
|
|
12
13
|
## Code Sample
|
|
@@ -17,6 +18,7 @@ require 'phrase'
|
|
|
17
18
|
instance = Phrase::OrganizationJobTemplateCreateParameters.new(name: 'template',
|
|
18
19
|
briefing: 'text',
|
|
19
20
|
autotranslate: true,
|
|
21
|
+
exclude_linked_child_keys: false,
|
|
20
22
|
owner_id: nil)
|
|
21
23
|
```
|
|
22
24
|
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
15
15
|
**creator** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
16
16
|
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
17
|
+
**exclude_linked_child_keys** | **Boolean** | `true` if jobs created from this template exclude linked child keys. | [optional]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
@@ -29,7 +30,8 @@ instance = Phrase::OrganizationJobTemplateDetails.new(id: nil,
|
|
|
29
30
|
updated_at: nil,
|
|
30
31
|
owner: nil,
|
|
31
32
|
creator: nil,
|
|
32
|
-
locales: nil
|
|
33
|
+
locales: nil,
|
|
34
|
+
exclude_linked_child_keys: false)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
|
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Job template name |
|
|
8
|
-
**briefing** | **String** | Briefing for the translators | [optional]
|
|
8
|
+
**briefing** | **String** | Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
9
9
|
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
10
|
+
**exclude_linked_child_keys** | **Boolean** | Exclude linked child keys from jobs created from this template. | [optional]
|
|
10
11
|
**owner_id** | **String** | Code of the account member to set as the job template owner. Pass an empty string to clear a previously set owner; when blank, the owner is set to null and jobs created from this template will default to assigning the job creator as owner. | [optional]
|
|
11
12
|
|
|
12
13
|
## Code Sample
|
|
@@ -17,6 +18,7 @@ require 'phrase'
|
|
|
17
18
|
instance = Phrase::OrganizationJobTemplateUpdateParameters.new(name: 'template',
|
|
18
19
|
briefing: 'text',
|
|
19
20
|
autotranslate: true,
|
|
21
|
+
exclude_linked_child_keys: false,
|
|
20
22
|
owner_id: nil)
|
|
21
23
|
```
|
|
22
24
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**account_id** | **String** | (Optional) ID of an account the requesting user belongs to. Used only to disambiguate the request context; the project itself cannot be moved between accounts through this endpoint. | [optional]
|
|
8
8
|
**name** | **String** | (Optional) Name of the project | [optional]
|
|
9
|
-
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. Pass `null` to unset. | [optional]
|
|
9
|
+
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. Pass `null` or an empty string to unset. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
10
10
|
**main_format** | **String** | (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364) or our [Formats API Endpoint](#formats). | [optional]
|
|
11
11
|
**media** | **String** | (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value. | [optional]
|
|
12
12
|
**shares_translation_memory** | **Boolean** | (Optional) Indicates whether the project should share the account's translation memory | [optional]
|
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**description** | **String** | Description of the release | [optional]
|
|
7
|
+
**description** | **String** | Description of the release. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
8
8
|
**platforms** | **Array<String>** | List of platforms the release should support. | [optional]
|
|
9
|
-
**app_min_version** | **String** | Minimum version of the app that the release supports in semver format | [optional]
|
|
10
|
-
**app_max_version** | **String** | Maximum version of the app that the release supports in semver format | [optional]
|
|
9
|
+
**app_min_version** | **String** | Minimum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
10
|
+
**app_max_version** | **String** | Maximum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
11
11
|
**branch** | **String** | Branch used for release | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
data/docs/RepoSyncEvent.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**pull_request_url** | **String** | URL of the pull request created on export | [optional]
|
|
12
12
|
**auto_import** | **Boolean** | Whether the import was triggered by the repo push event | [optional]
|
|
13
13
|
**errors** | **Array<String>** | List of error messages, in case of failure | [optional]
|
|
14
|
+
**uploads** | [**Array<RepoSyncEventUploadsInner>**](RepoSyncEventUploadsInner.md) | The uploads associated with this import event, or `null` if no upload batch has been created yet. Each entry identifies a single file upload by its public code (`id`) and its current public state (`state`). Present on show responses only; absent from list responses. Possible `state` values: `initialized`, `waiting_for_preview`, `processing`, `success`, `error`. | [optional]
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -23,7 +24,8 @@ instance = Phrase::RepoSyncEvent.new(id: nil,
|
|
|
23
24
|
status: nil,
|
|
24
25
|
pull_request_url: nil,
|
|
25
26
|
auto_import: nil,
|
|
26
|
-
errors: nil
|
|
27
|
+
errors: nil,
|
|
28
|
+
uploads: nil)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Phrase::RepoSyncEventUploadsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | The upload's public identifier (code). | [optional]
|
|
8
|
+
**state** | **String** | The upload's current public state. Multiple internal processing states are collapsed to `processing`; both internal error states are collapsed to `error`. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'phrase'
|
|
14
|
+
|
|
15
|
+
instance = Phrase::RepoSyncEventUploadsInner.new(id: 'abcd1234',
|
|
16
|
+
state: nil)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**name** | **String** | Name of the screenshot | [optional]
|
|
9
|
-
**description** | **String** | Description of the screenshot | [optional]
|
|
9
|
+
**description** | **String** | Description of the screenshot. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
10
10
|
**filename** | **File** | Screenshot file | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
@@ -5,18 +5,18 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**title** | **String** | Style guide title | [optional]
|
|
8
|
-
**audience** | **String** | Audience description | [optional]
|
|
8
|
+
**audience** | **String** | Audience description. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
9
9
|
**target_audience** | **String** | Target audience for the translations. | [optional]
|
|
10
10
|
**grammatical_person** | **String** | Preferred grammatical person. | [optional]
|
|
11
11
|
**vocabulary_type** | **String** | Vocabulary register the translations should use. | [optional]
|
|
12
|
-
**business** | **String** | Description of the business | [optional]
|
|
13
|
-
**company_branding** | **String** | Company branding to remain consistent. | [optional]
|
|
14
|
-
**formatting** | **String** | Formatting requirements and character limitations. | [optional]
|
|
15
|
-
**glossary_terms** | **String** | List of terms and/or phrases that need to be translated consistently. | [optional]
|
|
16
|
-
**grammar_consistency** | **String** | Formal or informal pronouns, consistent conjugation, grammatical gender | [optional]
|
|
17
|
-
**literal_translation** | **String** | Can be one of: Cultural/Conversational, Literal, Neutral. | [optional]
|
|
18
|
-
**overall_tone** | **String** | Tone requirement descriptions | [optional]
|
|
19
|
-
**samples** | **String** | Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. | [optional]
|
|
12
|
+
**business** | **String** | Description of the business. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
13
|
+
**company_branding** | **String** | Company branding to remain consistent. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
14
|
+
**formatting** | **String** | Formatting requirements and character limitations. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
15
|
+
**glossary_terms** | **String** | List of terms and/or phrases that need to be translated consistently. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
16
|
+
**grammar_consistency** | **String** | Formal or informal pronouns, consistent conjugation, grammatical gender. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
17
|
+
**literal_translation** | **String** | Can be one of: Cultural/Conversational, Literal, Neutral. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
18
|
+
**overall_tone** | **String** | Tone requirement descriptions. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
19
|
+
**samples** | **String** | Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
20
20
|
|
|
21
21
|
## Code Sample
|
|
22
22
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**content** | **String** | Translation content | [optional]
|
|
8
|
+
**content** | **String** | Translation content. Send an empty string or `null` to clear the translation's content; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional]
|
|
9
9
|
**plural_suffix** | **String** | Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized. | [optional]
|
|
10
10
|
**unverified** | **Boolean** | Indicates whether translation is unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
|
11
11
|
**excluded** | **Boolean** | Indicates whether translation is excluded. | [optional]
|
data/docs/TranslationsApi.md
CHANGED
|
@@ -643,7 +643,7 @@ opts = {
|
|
|
643
643
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
644
644
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
645
645
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
646
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards). The following qualifiers are supported in the query:
|
|
646
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids * `locale.name:locale_name,...` for queries on a comma-separated list of locale names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
|
|
647
647
|
}
|
|
648
648
|
|
|
649
649
|
begin
|
|
@@ -668,7 +668,7 @@ Name | Type | Description | Notes
|
|
|
668
668
|
**branch** | **String**| specify the branch to use | [optional]
|
|
669
669
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
670
670
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
671
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards). The following qualifiers are supported in the query:
|
|
671
|
+
**q** | **String**| Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids * `locale.name:locale_name,...` for queries on a comma-separated list of locale names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
672
672
|
|
|
673
673
|
### Return type
|
|
674
674
|
|
|
@@ -718,7 +718,7 @@ opts = {
|
|
|
718
718
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
719
719
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
720
720
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
721
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query:
|
|
721
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `key.id:key_id,...` for queries on a comma-separated list of translation key ids * `key.name:key_name,...` for queries on a comma-separated list of translation key names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
|
|
722
722
|
}
|
|
723
723
|
|
|
724
724
|
begin
|
|
@@ -743,7 +743,7 @@ Name | Type | Description | Notes
|
|
|
743
743
|
**branch** | **String**| specify the branch to use | [optional]
|
|
744
744
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
745
745
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
746
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query:
|
|
746
|
+
**q** | **String**| Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `key.id:key_id,...` for queries on a comma-separated list of translation key ids * `key.name:key_name,...` for queries on a comma-separated list of translation key names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
747
747
|
|
|
748
748
|
### Return type
|
|
749
749
|
|
|
@@ -922,7 +922,7 @@ opts = {
|
|
|
922
922
|
locale_id: 'abcd1234cdef1234abcd1234cdef1234', # String | Filter translations to those for the given locale (locale code or id). Equivalent to calling `GET /projects/{project_id}/locales/{locale_id}/translations`.
|
|
923
923
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
924
924
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
925
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query:
|
|
925
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `key.id:key_id,...` for queries on a comma-separated list of translation key ids * `key.name:key_name,...` for queries on a comma-separated list of translation key names * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids * `locale.name:locale_name,...` for queries on a comma-separated list of locale names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
|
|
926
926
|
}
|
|
927
927
|
|
|
928
928
|
begin
|
|
@@ -950,7 +950,7 @@ Name | Type | Description | Notes
|
|
|
950
950
|
**locale_id** | **String**| Filter translations to those for the given locale (locale code or id). Equivalent to calling `GET /projects/{project_id}/locales/{locale_id}/translations`. | [optional]
|
|
951
951
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
952
952
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
953
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query:
|
|
953
|
+
**q** | **String**| Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `key.id:key_id,...` for queries on a comma-separated list of translation key ids * `key.name:key_name,...` for queries on a comma-separated list of translation key names * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids * `locale.name:locale_name,...` for queries on a comma-separated list of locale names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
954
954
|
|
|
955
955
|
### Return type
|
|
956
956
|
|
|
@@ -1165,7 +1165,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
|
1165
1165
|
|
|
1166
1166
|
Unverify translations by query
|
|
1167
1167
|
|
|
1168
|
-
Mark translations matching query as unverified.
|
|
1168
|
+
Mark translations matching query as unverified. To unverify the translations of specific keys, filter by key id (and optionally locale) directly, for example `key.id:KEY_ID_1,KEY_ID_2 locale.id:LOCALE_ID`. There is no need to look up translation ids first.
|
|
1169
1169
|
|
|
1170
1170
|
### Example
|
|
1171
1171
|
|
|
@@ -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 find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query:
|
|
8
|
+
**q** | **String** | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `key.id:key_id,...` for queries on a comma-separated list of translation key ids * `key.name:key_name,...` for queries on a comma-separated list of translation key names * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids * `locale.name:locale_name,...` for queries on a comma-separated list of locale names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
11
11
|
|
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
require 'phrase'
|
|
16
16
|
|
|
17
17
|
instance = Phrase::TranslationsExcludeParameters.new(branch: 'my-feature-branch',
|
|
18
|
-
q: '
|
|
18
|
+
q: 'key.name:home.title,home.subtitle locale.name:de-DE tags:feature',
|
|
19
19
|
sort: 'updated_at',
|
|
20
20
|
order: 'desc')
|
|
21
21
|
```
|
|
@@ -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 find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query:
|
|
8
|
+
**q** | **String** | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of translation ids * `key.id:key_id,...` for queries on a comma-separated list of translation key ids * `key.name:key_name,...` for queries on a comma-separated list of translation key names * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids * `locale.name:locale_name,...` for queries on a comma-separated list of locale names * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
11
11
|
|
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
require 'phrase'
|
|
16
16
|
|
|
17
17
|
instance = Phrase::TranslationsIncludeParameters.new(branch: 'my-feature-branch',
|
|
18
|
-
q: '
|
|
18
|
+
q: 'key.name:home.title,home.subtitle locale.name:de-DE tags:feature',
|
|
19
19
|
sort: 'updated_at',
|
|
20
20
|
order: 'desc')
|
|
21
21
|
```
|