phrase 4.32.0 → 4.34.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 +15 -0
- data/Gemfile +1 -1
- data/README.md +6 -3
- 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 +2 -0
- data/docs/JobUpdateParameters.md +3 -1
- data/docs/KeysApi.md +6 -2
- data/docs/OrganizationJobTemplateCreateParameters.md +2 -0
- data/docs/OrganizationJobTemplateDetails.md +3 -1
- data/docs/OrganizationJobTemplateUpdateParameters.md +2 -0
- data/docs/RepoSyncEvent.md +3 -1
- data/docs/RepoSyncEventUploadsInner.md +19 -0
- data/docs/TranslationKey.md +3 -1
- data/docs/TranslationKeyDetails.md +2 -0
- data/docs/TranslationKeyLinkedKey.md +21 -0
- data/docs/TranslationKeyLinkedKeyParent.md +19 -0
- 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/lib/phrase/api/keys_api.rb +6 -0
- data/lib/phrase/api/translations_api.rb +8 -8
- 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 +11 -1
- data/lib/phrase/models/job_update_parameters.rb +14 -4
- 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 +11 -1
- 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/translation_key.rb +14 -4
- data/lib/phrase/models/translation_key_details.rb +11 -1
- data/lib/phrase/models/translation_key_linked_key.rb +253 -0
- data/lib/phrase/models/translation_key_linked_key_parent.rb +208 -0
- 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/version.rb +1 -1
- data/lib/phrase.rb +3 -0
- data/spec/api/keys_api_spec.rb +2 -0
- data/spec/api/translations_api_spec.rb +4 -4
- 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
- data/spec/models/translation_key_details_spec.rb +6 -0
- data/spec/models/translation_key_linked_key_parent_spec.rb +35 -0
- data/spec/models/translation_key_linked_key_spec.rb +45 -0
- data/spec/models/translation_key_spec.rb +6 -0
- metadata +280 -268
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 20c479a028a5c32ac1919a3e60bb3b6856319b440ffeca3197e7ad36d269619f
|
|
4
|
+
data.tar.gz: ff3f4f16b7d48e49203d2ccf5109c9b1a491d5276a8ba60c96b4fe2a129a4242
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0c318a2a14d1cdc5ca2d9eb47636585b0e7582a2bc3c2b7b044dd115e5392f58e3c4b2c5f9ae39903393b70c46ec2a8dbd6a18cba8ce01a70bf308027e2e1b0f
|
|
7
|
+
data.tar.gz: dbd8d3007e70708aee87fe3632c24b48cf5ec948c3e632bfb1a0be1aba06ed748c1cf1f16ef77ce24133336d996ecbcf24a23bcb421822219d3815358ead76d2
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.34.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.33.0...ruby-v4.34.0) (2026-11-05)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **API:** add linked_key field to key list responses #STRINGS-4425 ([#1361](https://github.com/phrase/strings-openapi/issues/1361)) ([e2cd0cd](https://github.com/phrase/strings-openapi/commit/e2cd0cdf327bed106f7c37f97324e77e997f0994))
|
|
9
|
+
|
|
10
|
+
## [4.33.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.32.0...ruby-v4.33.0) (2026-11-04)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **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))
|
|
16
|
+
* **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))
|
|
17
|
+
|
|
3
18
|
## [4.32.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.31.0...ruby-v4.32.0) (2026-10-22)
|
|
4
19
|
|
|
5
20
|
|
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.34.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.34.0.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./phrase-4.
|
|
62
|
+
(for development, run `gem install --dev ./phrase-4.34.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)
|
|
@@ -648,6 +649,8 @@ Class | Method | HTTP request | Description
|
|
|
648
649
|
- [Phrase::TranslationIncludeParameters](docs/TranslationIncludeParameters.md)
|
|
649
650
|
- [Phrase::TranslationKey](docs/TranslationKey.md)
|
|
650
651
|
- [Phrase::TranslationKeyDetails](docs/TranslationKeyDetails.md)
|
|
652
|
+
- [Phrase::TranslationKeyLinkedKey](docs/TranslationKeyLinkedKey.md)
|
|
653
|
+
- [Phrase::TranslationKeyLinkedKeyParent](docs/TranslationKeyLinkedKeyParent.md)
|
|
651
654
|
- [Phrase::TranslationOrder](docs/TranslationOrder.md)
|
|
652
655
|
- [Phrase::TranslationParent](docs/TranslationParent.md)
|
|
653
656
|
- [Phrase::TranslationReviewParameters](docs/TranslationReviewParameters.md)
|
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
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Job template name |
|
|
9
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
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
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/KeysApi.md
CHANGED
|
@@ -502,7 +502,8 @@ opts = {
|
|
|
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
504
|
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term: - `ids:key_id,...` for queries on a comma-separated list of ids - `name:key_name` for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
|
|
505
|
-
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
|
505
|
+
locale_id: 'abcd1234abcd1234abcd1234abcd1234', # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
|
506
|
+
include_linked_keys: true # Boolean | When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely.
|
|
506
507
|
}
|
|
507
508
|
|
|
508
509
|
begin
|
|
@@ -528,6 +529,7 @@ Name | Type | Description | Notes
|
|
|
528
529
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
529
530
|
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term: - `ids:key_id,...` for queries on a comma-separated list of ids - `name:key_name` for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
530
531
|
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
532
|
+
**include_linked_keys** | **Boolean**| When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely. | [optional]
|
|
531
533
|
|
|
532
534
|
### Return type
|
|
533
535
|
|
|
@@ -573,7 +575,8 @@ keys_search_parameters = Phrase::KeysSearchParameters.new # KeysSearchParameters
|
|
|
573
575
|
opts = {
|
|
574
576
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
575
577
|
page: 1, # Integer | Page number
|
|
576
|
-
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
578
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
579
|
+
include_linked_keys: true # Boolean | When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely.
|
|
577
580
|
}
|
|
578
581
|
|
|
579
582
|
begin
|
|
@@ -595,6 +598,7 @@ Name | Type | Description | Notes
|
|
|
595
598
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
596
599
|
**page** | **Integer**| Page number | [optional]
|
|
597
600
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
601
|
+
**include_linked_keys** | **Boolean**| When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely. | [optional]
|
|
598
602
|
|
|
599
603
|
### Return type
|
|
600
604
|
|
|
@@ -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
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | Job template name |
|
|
8
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
|
|
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
|
+
|
data/docs/TranslationKey.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**data_type** | **String** | | [optional]
|
|
15
15
|
**created_at** | **Time** | | [optional]
|
|
16
16
|
**updated_at** | **Time** | | [optional]
|
|
17
|
+
**linked_key** | [**TranslationKeyLinkedKey**](TranslationKeyLinkedKey.md) | | [optional]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
@@ -29,7 +30,8 @@ instance = Phrase::TranslationKey.new(id: nil,
|
|
|
29
30
|
tags: nil,
|
|
30
31
|
data_type: nil,
|
|
31
32
|
created_at: nil,
|
|
32
|
-
updated_at: nil
|
|
33
|
+
updated_at: nil,
|
|
34
|
+
linked_key: nil)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**data_type** | **String** | | [optional]
|
|
15
15
|
**created_at** | **Time** | | [optional]
|
|
16
16
|
**updated_at** | **Time** | | [optional]
|
|
17
|
+
**linked_key** | [**TranslationKeyLinkedKey**](TranslationKeyLinkedKey.md) | | [optional]
|
|
17
18
|
**name_plural** | **String** | | [optional]
|
|
18
19
|
**comments_count** | **Integer** | | [optional]
|
|
19
20
|
**max_characters_allowed** | **Integer** | | [optional]
|
|
@@ -40,6 +41,7 @@ instance = Phrase::TranslationKeyDetails.new(id: nil,
|
|
|
40
41
|
data_type: nil,
|
|
41
42
|
created_at: nil,
|
|
42
43
|
updated_at: nil,
|
|
44
|
+
linked_key: nil,
|
|
43
45
|
name_plural: nil,
|
|
44
46
|
comments_count: nil,
|
|
45
47
|
max_characters_allowed: nil,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Phrase::TranslationKeyLinkedKey
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**role** | **String** | Whether this key is the parent or the child in the link relationship. | [optional]
|
|
8
|
+
**parent** | [**TranslationKeyLinkedKeyParent**](TranslationKeyLinkedKeyParent.md) | | [optional]
|
|
9
|
+
**children_count** | **Integer** | The number of linked child keys. Set for parent keys. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'phrase'
|
|
15
|
+
|
|
16
|
+
instance = Phrase::TranslationKeyLinkedKey.new(role: nil,
|
|
17
|
+
parent: nil,
|
|
18
|
+
children_count: 3)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Phrase::TranslationKeyLinkedKeyParent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | The parent key's public identifier (code). | [optional]
|
|
8
|
+
**name** | **String** | The parent key's name. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'phrase'
|
|
14
|
+
|
|
15
|
+
instance = Phrase::TranslationKeyLinkedKeyParent.new(id: 'abc12345def67890abc12345def67890',
|
|
16
|
+
name: 'home.welcome.title')
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
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
|
```
|
|
@@ -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
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
require 'phrase'
|
|
14
14
|
|
|
15
15
|
instance = Phrase::TranslationsReviewParameters.new(branch: 'my-feature-branch',
|
|
16
|
-
q: '
|
|
16
|
+
q: 'key.name:home.title,home.subtitle locale.name:de-DE tags:feature')
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**sort** | **String** | Sort criteria. Can be one of: key_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 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:
|
|
10
|
+
**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]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ require 'phrase'
|
|
|
17
17
|
instance = Phrase::TranslationsSearchParameters.new(branch: 'my-feature-branch',
|
|
18
18
|
sort: 'updated_at',
|
|
19
19
|
order: 'desc',
|
|
20
|
-
q: '
|
|
20
|
+
q: 'key.name:home.title,home.subtitle locale.name:de-DE tags:feature')
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
|
@@ -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: * `id:translation_id,...` for queries on a comma-separated list of ids * `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 Find more examples [here](/en/api/strings/usage-examples). | [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: * `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
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
require 'phrase'
|
|
14
14
|
|
|
15
15
|
instance = Phrase::TranslationsUnreviewParameters.new(branch: 'my-feature-branch',
|
|
16
|
-
q: '
|
|
16
|
+
q: 'key.name:home.title,home.subtitle locale.name:de-DE tags:feature')
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
|