phrase 4.5.0 → 4.8.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 +23 -0
- data/README.md +12 -3
- data/docs/BranchesApi.md +3 -3
- data/docs/DistributionCreateParameters.md +1 -1
- data/docs/DistributionUpdateParameters.md +1 -1
- data/docs/InvitationCreateParameters.md +2 -2
- data/docs/InvitationsApi.md +7 -7
- data/docs/JobAnnotation.md +23 -0
- data/docs/JobAnnotationShort.md +19 -0
- data/docs/JobAnnotationUpdateParameters.md +19 -0
- data/docs/JobAnnotationsApi.md +416 -0
- data/docs/JobDetails.md +3 -1
- data/docs/JobLocale.md +3 -1
- data/docs/JobLocalesApi.md +6 -2
- data/docs/JobsApi.md +8 -6
- data/docs/KeyCreateParameters.md +3 -1
- data/docs/KeyPreview.md +3 -1
- data/docs/KeyUpdateParameters.md +3 -1
- data/docs/KeysApi.md +4 -4
- data/docs/KeysExcludeParameters.md +1 -1
- data/docs/KeysIncludeParameters.md +1 -1
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/Locale.md +2 -0
- data/docs/LocaleCreateParameters.md +3 -3
- data/docs/LocaleDetails.md +2 -0
- data/docs/LocaleDownloadCreateParameters.md +7 -5
- data/docs/LocaleDownloadsApi.md +8 -8
- data/docs/LocaleUpdateParameters.md +3 -3
- data/docs/LocalesApi.md +17 -15
- data/docs/MemberUpdateParameters.md +1 -1
- data/docs/MembersApi.md +5 -5
- data/docs/OrdersApi.md +1 -1
- data/docs/ProjectCreateParameters.md +5 -5
- data/docs/ProjectUpdateParameters.md +6 -6
- data/docs/ReleaseTriggersApi.md +1 -1
- data/docs/ScreenshotMarkerCreateParameters.md +1 -1
- data/docs/ScreenshotMarkerUpdateParameters.md +1 -1
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/SearchApi.md +1 -1
- data/docs/TagsApi.md +2 -0
- data/docs/TranslationCreateParameters.md +1 -1
- data/docs/TranslationKey.md +2 -0
- data/docs/TranslationKeyDetails.md +2 -0
- data/docs/TranslationUpdateParameters.md +1 -1
- data/docs/TranslationsApi.md +13 -13
- data/docs/TranslationsExcludeParameters.md +1 -1
- data/docs/TranslationsIncludeParameters.md +1 -1
- data/docs/TranslationsReviewParameters.md +1 -1
- data/docs/TranslationsSearchParameters.md +1 -1
- data/docs/TranslationsUnreviewParameters.md +1 -1
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/lib/phrase/api/branches_api.rb +6 -6
- data/lib/phrase/api/invitations_api.rb +14 -14
- data/lib/phrase/api/job_annotations_api.rb +508 -0
- data/lib/phrase/api/job_locales_api.rb +6 -0
- data/lib/phrase/api/jobs_api.rb +9 -6
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locale_downloads_api.rb +8 -8
- data/lib/phrase/api/locales_api.rb +17 -14
- data/lib/phrase/api/members_api.rb +10 -10
- data/lib/phrase/api/orders_api.rb +2 -2
- data/lib/phrase/api/release_triggers_api.rb +2 -2
- data/lib/phrase/api/search_api.rb +2 -2
- data/lib/phrase/api/tags_api.rb +3 -0
- data/lib/phrase/api/translations_api.rb +16 -16
- data/lib/phrase/models/distribution_create_parameters.rb +1 -1
- data/lib/phrase/models/distribution_update_parameters.rb +1 -1
- data/lib/phrase/models/invitation_create_parameters.rb +2 -2
- data/lib/phrase/models/job_annotation.rb +233 -0
- data/lib/phrase/models/job_annotation_short.rb +215 -0
- data/lib/phrase/models/job_annotation_update_parameters.rb +207 -0
- data/lib/phrase/models/job_details.rb +15 -4
- data/lib/phrase/models/job_locale.rb +15 -4
- data/lib/phrase/models/key_create_parameters.rb +11 -1
- data/lib/phrase/models/key_preview.rb +13 -4
- data/lib/phrase/models/key_update_parameters.rb +11 -1
- data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
- data/lib/phrase/models/keys_include_parameters.rb +1 -1
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/locale.rb +12 -1
- data/lib/phrase/models/locale_create_parameters.rb +3 -3
- data/lib/phrase/models/locale_details.rb +12 -1
- data/lib/phrase/models/locale_download_create_parameters.rb +18 -8
- data/lib/phrase/models/locale_update_parameters.rb +3 -3
- data/lib/phrase/models/member_update_parameters.rb +1 -1
- data/lib/phrase/models/project_create_parameters.rb +4 -4
- data/lib/phrase/models/project_update_parameters.rb +5 -5
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +1 -1
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +1 -1
- data/lib/phrase/models/translation_create_parameters.rb +1 -1
- data/lib/phrase/models/translation_key.rb +10 -1
- data/lib/phrase/models/translation_key_details.rb +10 -1
- data/lib/phrase/models/translation_update_parameters.rb +1 -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/version.rb +1 -1
- data/lib/phrase.rb +4 -0
- data/spec/api/branches_api_spec.rb +3 -3
- data/spec/api/invitations_api_spec.rb +7 -7
- data/spec/api/job_annotations_api_spec.rb +120 -0
- data/spec/api/job_locales_api_spec.rb +2 -0
- data/spec/api/jobs_api_spec.rb +4 -3
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locale_downloads_api_spec.rb +4 -4
- data/spec/api/members_api_spec.rb +5 -5
- data/spec/api/orders_api_spec.rb +1 -1
- data/spec/api/release_triggers_api_spec.rb +1 -1
- data/spec/api/search_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +1 -0
- data/spec/api/translations_api_spec.rb +8 -8
- data/spec/models/job_annotation_short_spec.rb +35 -0
- data/spec/models/job_annotation_spec.rb +47 -0
- data/spec/models/job_annotation_update_parameters_spec.rb +35 -0
- data/spec/models/job_details_spec.rb +6 -0
- data/spec/models/job_locale_spec.rb +6 -0
- data/spec/models/key_create_parameters_spec.rb +6 -0
- data/spec/models/key_preview_spec.rb +6 -0
- data/spec/models/key_update_parameters_spec.rb +6 -0
- data/spec/models/locale_details_spec.rb +6 -0
- data/spec/models/locale_download_create_parameters_spec.rb +6 -0
- data/spec/models/locale_spec.rb +6 -0
- data/spec/models/translation_key_details_spec.rb +6 -0
- data/spec/models/translation_key_spec.rb +6 -0
- metadata +247 -231
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
|
|
11
11
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
|
9
9
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
10
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards)
|
|
10
|
+
**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 a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes * `tags:tag_name,...` to filter for keys with certain comma-seperated list of tags * `uploads:upload_id,...` to filter for keys with certain comma-seperated list of uploads * `job:{true|false}` to filter for keys mentioned in an active job * `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 Find more examples [here](/en/api/strings/usage-examples). Please note: If `tags` are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
|
|
11
11
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
data/docs/KeysTagParameters.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
|
|
11
11
|
|
data/docs/KeysUntagParameters.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to remove from the matching collection of keys | [optional]
|
|
11
11
|
|
data/docs/Locale.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**main** | **Boolean** | | [optional]
|
|
12
12
|
**rtl** | **Boolean** | | [optional]
|
|
13
13
|
**plural_forms** | **Array<String>** | | [optional]
|
|
14
|
+
**ordinal_plural_forms** | **Array<String>** | | [optional]
|
|
14
15
|
**source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
15
16
|
**fallback_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
16
17
|
**created_at** | **Time** | | [optional]
|
|
@@ -28,6 +29,7 @@ instance = Phrase::Locale.new(id: null,
|
|
|
28
29
|
main: null,
|
|
29
30
|
rtl: null,
|
|
30
31
|
plural_forms: null,
|
|
32
|
+
ordinal_plural_forms: null,
|
|
31
33
|
source_locale: null,
|
|
32
34
|
fallback_locale: null,
|
|
33
35
|
created_at: null,
|
|
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Locale name |
|
|
9
9
|
**code** | **String** | Locale ISO code |
|
|
10
10
|
**default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
|
|
11
|
-
**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the
|
|
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
14
|
**fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional]
|
|
15
|
-
**unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the
|
|
16
|
-
**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the
|
|
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
|
+
**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
|
**autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional]
|
|
18
18
|
|
|
19
19
|
## Code Sample
|
data/docs/LocaleDetails.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**main** | **Boolean** | | [optional]
|
|
12
12
|
**rtl** | **Boolean** | | [optional]
|
|
13
13
|
**plural_forms** | **Array<String>** | | [optional]
|
|
14
|
+
**ordinal_plural_forms** | **Array<String>** | | [optional]
|
|
14
15
|
**source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
15
16
|
**fallback_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
16
17
|
**created_at** | **Time** | | [optional]
|
|
@@ -29,6 +30,7 @@ instance = Phrase::LocaleDetails.new(id: null,
|
|
|
29
30
|
main: null,
|
|
30
31
|
rtl: null,
|
|
31
32
|
plural_forms: null,
|
|
33
|
+
ordinal_plural_forms: null,
|
|
32
34
|
source_locale: null,
|
|
33
35
|
fallback_locale: null,
|
|
34
36
|
created_at: null,
|
|
@@ -4,21 +4,22 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**file_format** | **String** | File format name. See the
|
|
7
|
+
**file_format** | **String** | File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats. |
|
|
8
8
|
**branch** | **String** | specify the branch to use | [optional]
|
|
9
9
|
**tags** | **String** | Limit results to keys tagged with a list of comma separated tag names. | [optional]
|
|
10
10
|
**include_empty_translations** | **Boolean** | Indicates whether keys without translations should be included in the output as well. | [optional]
|
|
11
11
|
**exclude_empty_zero_forms** | **Boolean** | Indicates whether zero forms should be included when empty in pluralized keys. | [optional]
|
|
12
12
|
**include_translated_keys** | **Boolean** | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
|
|
13
13
|
**keep_notranslate_tags** | **Boolean** | Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
|
|
14
|
-
**format_options** | **Object** | Additional formatting and render options. See the
|
|
14
|
+
**format_options** | **Object** | Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar` | [optional]
|
|
15
15
|
**encoding** | **String** | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
|
|
16
16
|
**include_unverified_translations** | **Boolean** | if set to false unverified translations are excluded | [optional]
|
|
17
17
|
**use_last_reviewed_version** | **Boolean** | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional]
|
|
18
18
|
**locale_ids** | **Array<String>** | Locale IDs or locale names | [optional]
|
|
19
|
-
**fallback_locale_id** | **String** | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to
|
|
20
|
-
**source_locale_id** | **String** | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a
|
|
19
|
+
**fallback_locale_id** | **String** | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`. | [optional]
|
|
20
|
+
**source_locale_id** | **String** | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job. | [optional]
|
|
21
21
|
**custom_metadata_filters** | **Object** | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. | [optional]
|
|
22
|
+
**updated_since** | **String** | Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`). | [optional]
|
|
22
23
|
|
|
23
24
|
## Code Sample
|
|
24
25
|
|
|
@@ -39,7 +40,8 @@ instance = Phrase::LocaleDownloadCreateParameters.new(file_format: yml,
|
|
|
39
40
|
locale_ids: ["de","en"],
|
|
40
41
|
fallback_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
41
42
|
source_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
42
|
-
custom_metadata_filters: null
|
|
43
|
+
custom_metadata_filters: null,
|
|
44
|
+
updated_since: 2023-01-01T00:00:00Z)
|
|
43
45
|
```
|
|
44
46
|
|
|
45
47
|
|
data/docs/LocaleDownloadsApi.md
CHANGED
|
@@ -39,8 +39,8 @@ locale_id = 'locale_id_example' # String | Locale ID
|
|
|
39
39
|
locale_download_create_parameters = Phrase::LocaleDownloadCreateParameters.new({file_format: 'yml'}) # LocaleDownloadCreateParameters |
|
|
40
40
|
opts = {
|
|
41
41
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
42
|
-
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see
|
|
43
|
-
if_none_match: 'if_none_match_example' # String | ETag condition, see
|
|
42
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
|
43
|
+
if_none_match: 'if_none_match_example' # String | ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
begin
|
|
@@ -61,8 +61,8 @@ Name | Type | Description | Notes
|
|
|
61
61
|
**locale_id** | **String**| Locale ID |
|
|
62
62
|
**locale_download_create_parameters** | [**LocaleDownloadCreateParameters**](LocaleDownloadCreateParameters.md)| |
|
|
63
63
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
64
|
-
**if_modified_since** | **String**| Last modified condition, see
|
|
65
|
-
**if_none_match** | **String**| ETag condition, see
|
|
64
|
+
**if_modified_since** | **String**| Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
|
65
|
+
**if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
|
66
66
|
|
|
67
67
|
### Return type
|
|
68
68
|
|
|
@@ -108,8 +108,8 @@ locale_id = 'locale_id_example' # String | Locale ID
|
|
|
108
108
|
id = 'id_example' # String | ID
|
|
109
109
|
opts = {
|
|
110
110
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
111
|
-
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see
|
|
112
|
-
if_none_match: 'if_none_match_example' # String | ETag condition, see
|
|
111
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
|
112
|
+
if_none_match: 'if_none_match_example' # String | ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
|
113
113
|
}
|
|
114
114
|
|
|
115
115
|
begin
|
|
@@ -130,8 +130,8 @@ Name | Type | Description | Notes
|
|
|
130
130
|
**locale_id** | **String**| Locale ID |
|
|
131
131
|
**id** | **String**| ID |
|
|
132
132
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
133
|
-
**if_modified_since** | **String**| Last modified condition, see
|
|
134
|
-
**if_none_match** | **String**| ETag condition, see
|
|
133
|
+
**if_modified_since** | **String**| Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
|
134
|
+
**if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
|
135
135
|
|
|
136
136
|
### Return type
|
|
137
137
|
|
|
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Locale name | [optional]
|
|
9
9
|
**code** | **String** | Locale ISO code | [optional]
|
|
10
10
|
**default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
|
|
11
|
-
**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the
|
|
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
14
|
**fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional]
|
|
15
|
-
**unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the
|
|
16
|
-
**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the
|
|
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
|
+
**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
|
**autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional]
|
|
18
18
|
|
|
19
19
|
## Code Sample
|
data/docs/LocalesApi.md
CHANGED
|
@@ -235,10 +235,10 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
235
235
|
id = 'id_example' # String | Locale ID or locale name
|
|
236
236
|
opts = {
|
|
237
237
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
238
|
-
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see
|
|
239
|
-
if_none_match: 'if_none_match_example', # String | ETag condition, see
|
|
238
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
|
239
|
+
if_none_match: 'if_none_match_example', # String | ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
|
240
240
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
241
|
-
file_format: 'yml', # String | File format name. See the
|
|
241
|
+
file_format: 'yml', # String | File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats.
|
|
242
242
|
tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
|
|
243
243
|
tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
|
|
244
244
|
include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
|
|
@@ -246,17 +246,18 @@ opts = {
|
|
|
246
246
|
include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
|
|
247
247
|
keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
|
|
248
248
|
convert_emoji: true, # Boolean | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
|
|
249
|
-
format_options: { key: 3.56}, # Object | Additional formatting and render options. See the
|
|
249
|
+
format_options: { key: 3.56}, # Object | Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar`
|
|
250
250
|
encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
|
|
251
|
-
skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with
|
|
251
|
+
skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`.
|
|
252
252
|
include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
|
|
253
253
|
use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
|
|
254
|
-
fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to
|
|
255
|
-
source_locale_id: 'source_locale_id_example', # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a
|
|
254
|
+
fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`.
|
|
255
|
+
source_locale_id: 'source_locale_id_example', # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job.
|
|
256
256
|
translation_key_prefix: 'prefix_', # String | Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.
|
|
257
257
|
filter_by_prefix: true, # Boolean | Only download translation keys containing the specified prefix, and remove the prefix from the generated file.
|
|
258
258
|
custom_metadata_filters: { key: 3.56}, # Object | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.
|
|
259
|
-
locale_ids: ['inner_example'] # Array<String> | Locale IDs or locale names
|
|
259
|
+
locale_ids: ['inner_example'], # Array<String> | Locale IDs or locale names
|
|
260
|
+
updated_since: '2023-01-01T00:00:00Z' # String | Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
|
|
260
261
|
}
|
|
261
262
|
|
|
262
263
|
begin
|
|
@@ -276,10 +277,10 @@ Name | Type | Description | Notes
|
|
|
276
277
|
**project_id** | **String**| Project ID |
|
|
277
278
|
**id** | **String**| Locale ID or locale name |
|
|
278
279
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
279
|
-
**if_modified_since** | **String**| Last modified condition, see
|
|
280
|
-
**if_none_match** | **String**| ETag condition, see
|
|
280
|
+
**if_modified_since** | **String**| Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
|
281
|
+
**if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
|
281
282
|
**branch** | **String**| specify the branch to use | [optional]
|
|
282
|
-
**file_format** | **String**| File format name. See the
|
|
283
|
+
**file_format** | **String**| File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats. | [optional]
|
|
283
284
|
**tags** | **String**| Limit results to keys tagged with a list of comma separated tag names. | [optional]
|
|
284
285
|
**tag** | **String**| Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead | [optional]
|
|
285
286
|
**include_empty_translations** | **Boolean**| Indicates whether keys without translations should be included in the output as well. | [optional]
|
|
@@ -287,17 +288,18 @@ Name | Type | Description | Notes
|
|
|
287
288
|
**include_translated_keys** | **Boolean**| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
|
|
288
289
|
**keep_notranslate_tags** | **Boolean**| Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
|
|
289
290
|
**convert_emoji** | **Boolean**| This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | [optional]
|
|
290
|
-
**format_options** | [**Object**](.md)| Additional formatting and render options. See the
|
|
291
|
+
**format_options** | [**Object**](.md)| Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar` | [optional]
|
|
291
292
|
**encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
|
|
292
|
-
**skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with
|
|
293
|
+
**skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`. | [optional]
|
|
293
294
|
**include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional]
|
|
294
295
|
**use_last_reviewed_version** | **Boolean**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional]
|
|
295
|
-
**fallback_locale_id** | **String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to
|
|
296
|
-
**source_locale_id** | **String**| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a
|
|
296
|
+
**fallback_locale_id** | **String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`. | [optional]
|
|
297
|
+
**source_locale_id** | **String**| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job. | [optional]
|
|
297
298
|
**translation_key_prefix** | **String**| Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed. | [optional]
|
|
298
299
|
**filter_by_prefix** | **Boolean**| Only download translation keys containing the specified prefix, and remove the prefix from the generated file. | [optional]
|
|
299
300
|
**custom_metadata_filters** | [**Object**](.md)| Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. | [optional]
|
|
300
301
|
**locale_ids** | [**Array<String>**](String.md)| Locale IDs or locale names | [optional]
|
|
302
|
+
**updated_since** | **String**| Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`). | [optional]
|
|
301
303
|
|
|
302
304
|
### Return type
|
|
303
305
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**locale_ids** | **String** | List of locale ids the user has access to. | [optional]
|
|
11
11
|
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
|
12
12
|
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
|
13
|
-
**permissions** | **Hash<String, String>** | Additional permissions depending on member role. Available permissions are
|
|
13
|
+
**permissions** | **Hash<String, String>** | Additional permissions depending on member role. Available permissions are `create_upload` and `review_translations` | [optional]
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
data/docs/MembersApi.md
CHANGED
|
@@ -18,7 +18,7 @@ Method | HTTP request | Description
|
|
|
18
18
|
|
|
19
19
|
Remove a user from the account
|
|
20
20
|
|
|
21
|
-
Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include
|
|
21
|
+
Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include `team.manage`.
|
|
22
22
|
|
|
23
23
|
### Example
|
|
24
24
|
|
|
@@ -80,7 +80,7 @@ Response<(nil (empty response body))>
|
|
|
80
80
|
|
|
81
81
|
Get single member
|
|
82
82
|
|
|
83
|
-
Get details on a single user in the account. Access token scope must include
|
|
83
|
+
Get details on a single user in the account. Access token scope must include `team.manage`.
|
|
84
84
|
|
|
85
85
|
### Example
|
|
86
86
|
|
|
@@ -143,7 +143,7 @@ Response<([**Member**](Member.md))>
|
|
|
143
143
|
|
|
144
144
|
Update a member
|
|
145
145
|
|
|
146
|
-
Update user permissions in the account. Developers and translators need
|
|
146
|
+
Update user permissions in the account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
|
147
147
|
|
|
148
148
|
### Example
|
|
149
149
|
|
|
@@ -208,7 +208,7 @@ Response<([**Member**](Member.md))>
|
|
|
208
208
|
|
|
209
209
|
Update a member's project settings
|
|
210
210
|
|
|
211
|
-
Update user settings in the project. Access token scope must include
|
|
211
|
+
Update user settings in the project. Access token scope must include `team.manage`.
|
|
212
212
|
|
|
213
213
|
### Example
|
|
214
214
|
|
|
@@ -273,7 +273,7 @@ Response<([**MemberProjectDetail**](MemberProjectDetail.md))>
|
|
|
273
273
|
|
|
274
274
|
List members
|
|
275
275
|
|
|
276
|
-
Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include
|
|
276
|
+
Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
|
|
277
277
|
|
|
278
278
|
### Example
|
|
279
279
|
|
data/docs/OrdersApi.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Name of the project |
|
|
8
|
-
**main_format** | **String** | 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
|
|
8
|
+
**main_format** | **String** | 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](/en/api/strings/formats/list-formats). | [optional]
|
|
9
9
|
**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]
|
|
10
10
|
**shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional]
|
|
11
11
|
**project_image** | **File** | Image to identify the project | [optional]
|
|
@@ -13,14 +13,14 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
14
14
|
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. | [optional]
|
|
15
15
|
**source_project_id** | **String** | When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params. | [optional]
|
|
16
|
-
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\".
|
|
16
|
+
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". [Read more](https://support.phrase.com/hc/en-us/articles/5784094755484) | [optional]
|
|
17
17
|
**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Pre-Translation | [optional]
|
|
18
18
|
**enable_branching** | **Boolean** | (Optional) Enable branching in the project | [optional]
|
|
19
19
|
**protect_master_branch** | **Boolean** | (Optional) Protect the master branch in project where branching is enabled | [optional]
|
|
20
20
|
**enable_all_data_type_translation_keys_for_translators** | **Boolean** | (Optional) Otherwise, translators are not allowed to edit translations other than strings | [optional]
|
|
21
|
-
**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages.
|
|
21
|
+
**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages. [Read more](https://support.phrase.com/hc/en-us/articles/5822319545116) | [optional]
|
|
22
22
|
**zero_plural_form_enabled** | **Boolean** | (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. | [optional]
|
|
23
|
-
**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled.
|
|
23
|
+
**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled. [Read more](https://support.phrase.com/hc/en-us/articles/5822187934364) | [optional]
|
|
24
24
|
**autotranslate_check_new_translation_keys** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
25
25
|
**autotranslate_check_new_uploads** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
26
26
|
**autotranslate_check_new_locales** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
@@ -37,7 +37,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
|
|
|
37
37
|
main_format: yml,
|
|
38
38
|
media: Python,
|
|
39
39
|
shares_translation_memory: true,
|
|
40
|
-
project_image: [B@
|
|
40
|
+
project_image: [B@298517d1,
|
|
41
41
|
remove_project_image: null,
|
|
42
42
|
account_id: abcd1234,
|
|
43
43
|
point_of_contact: abcd1234,
|
|
@@ -7,26 +7,26 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional]
|
|
8
8
|
**name** | **String** | (Optional) Name of the project | [optional]
|
|
9
9
|
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. Pass `null` to unset. | [optional]
|
|
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
|
|
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]
|
|
13
13
|
**project_image** | **File** | (Optional) Image to identify the project | [optional]
|
|
14
14
|
**remove_project_image** | **Boolean** | (Optional) Indicates whether the project image should be deleted. | [optional]
|
|
15
|
-
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\".
|
|
15
|
+
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". [Read more](https://support.phrase.com/hc/en-us/articles/5784094755484) | [optional]
|
|
16
16
|
**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Pre-Translation | [optional]
|
|
17
17
|
**enable_branching** | **Boolean** | (Optional) Enable branching in the project | [optional]
|
|
18
18
|
**protect_master_branch** | **Boolean** | (Optional) Protect the master branch in project where branching is enabled | [optional]
|
|
19
19
|
**enable_all_data_type_translation_keys_for_translators** | **Boolean** | (Optional) Otherwise, translators are not allowed to edit translations other than strings | [optional]
|
|
20
|
-
**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages.
|
|
20
|
+
**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages. [Read more](https://support.phrase.com/hc/en-us/articles/5822319545116) | [optional]
|
|
21
21
|
**zero_plural_form_enabled** | **Boolean** | (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. | [optional]
|
|
22
|
-
**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled.
|
|
22
|
+
**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled. [Read more](https://support.phrase.com/hc/en-us/articles/5822187934364) | [optional]
|
|
23
23
|
**autotranslate_check_new_translation_keys** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
24
24
|
**autotranslate_check_new_uploads** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
25
25
|
**autotranslate_check_new_locales** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
26
26
|
**autotranslate_mark_as_unverified** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
27
27
|
**autotranslate_use_machine_translation** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
28
28
|
**autotranslate_use_translation_memory** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
29
|
-
**default_encoding** | **String** | (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the
|
|
29
|
+
**default_encoding** | **String** | (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the [`file_encoding`](/en/api/strings/uploads/upload-a-new-file) parameter for Uploads. | [optional]
|
|
30
30
|
|
|
31
31
|
## Code Sample
|
|
32
32
|
|
|
@@ -39,7 +39,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
|
|
|
39
39
|
main_format: yml,
|
|
40
40
|
media: Python,
|
|
41
41
|
shares_translation_memory: true,
|
|
42
|
-
project_image: [B@
|
|
42
|
+
project_image: [B@3a00f386,
|
|
43
43
|
remove_project_image: false,
|
|
44
44
|
workflow: review,
|
|
45
45
|
machine_translation_enabled: true,
|
data/docs/ReleaseTriggersApi.md
CHANGED
|
@@ -147,7 +147,7 @@ Response<(nil (empty response body))>
|
|
|
147
147
|
|
|
148
148
|
List release triggers
|
|
149
149
|
|
|
150
|
-
List all release triggers for the given distribution
|
|
150
|
+
List all release triggers for the given distribution. Note: Currently only one release trigger can exist per distribution.
|
|
151
151
|
|
|
152
152
|
### Example
|
|
153
153
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. |
|
|
9
|
-
**presentation** | **String** | Presentation details of the screenshot marker in JSON format
|
|
9
|
+
**presentation** | **String** | Presentation details of the screenshot marker in JSON format. Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (`x`-axis and `y`-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (`w` and `h` in pixels). | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional]
|
|
9
|
-
**presentation** | **String** | Presentation details of the screenshot marker in JSON format
|
|
9
|
+
**presentation** | **String** | Presentation details of the screenshot marker in JSON format. Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (`x`-axis and `y`-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (`w` and `h` in pixels). | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
data/docs/SearchApi.md
CHANGED
|
@@ -14,7 +14,7 @@ Method | HTTP request | Description
|
|
|
14
14
|
|
|
15
15
|
Search across projects
|
|
16
16
|
|
|
17
|
-
Search for keys and translations in all account projects
|
|
17
|
+
Search for keys and translations in all account projects *Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.*
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
data/docs/TagsApi.md
CHANGED
|
@@ -167,6 +167,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
167
167
|
name = 'name_example' # String | name
|
|
168
168
|
opts = {
|
|
169
169
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
170
|
+
omit_statistics: true, # Boolean | omit statistics in the response
|
|
170
171
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
171
172
|
}
|
|
172
173
|
|
|
@@ -187,6 +188,7 @@ Name | Type | Description | Notes
|
|
|
187
188
|
**project_id** | **String**| Project ID |
|
|
188
189
|
**name** | **String**| name |
|
|
189
190
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
191
|
+
**omit_statistics** | **Boolean**| omit statistics in the response | [optional]
|
|
190
192
|
**branch** | **String**| specify the branch to use | [optional]
|
|
191
193
|
|
|
192
194
|
### Return type
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**key_id** | **String** | Key | [optional]
|
|
10
10
|
**content** | **String** | Translation content | [optional]
|
|
11
11
|
**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]
|
|
12
|
-
**unverified** | **Boolean** | Indicates whether translation is unverified. Part of the
|
|
12
|
+
**unverified** | **Boolean** | Indicates whether translation is unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
|
13
13
|
**excluded** | **Boolean** | Indicates whether translation is excluded. | [optional]
|
|
14
14
|
**autotranslate** | **Boolean** | Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. | [optional]
|
|
15
15
|
|
data/docs/TranslationKey.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**description** | **String** | | [optional]
|
|
10
10
|
**name_hash** | **String** | | [optional]
|
|
11
11
|
**plural** | **Boolean** | | [optional]
|
|
12
|
+
**use_ordinal_rules** | **Boolean** | | [optional]
|
|
12
13
|
**tags** | **Array<String>** | | [optional]
|
|
13
14
|
**data_type** | **String** | | [optional]
|
|
14
15
|
**created_at** | **Time** | | [optional]
|
|
@@ -24,6 +25,7 @@ instance = Phrase::TranslationKey.new(id: null,
|
|
|
24
25
|
description: null,
|
|
25
26
|
name_hash: null,
|
|
26
27
|
plural: null,
|
|
28
|
+
use_ordinal_rules: null,
|
|
27
29
|
tags: null,
|
|
28
30
|
data_type: null,
|
|
29
31
|
created_at: null,
|