phrase 4.16.1 → 4.18.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 +148 -123
- data/README.md +8 -3
- data/docs/JobCreateParameters.md +3 -1
- data/docs/JobTemplateCreateParameters.md +3 -1
- data/docs/JobTemplateUpdateParameters.md +3 -1
- data/docs/JobUpdateParameters.md +3 -1
- data/docs/KeyCreateParameters.md +1 -1
- data/docs/KeyUpdateParameters.md +1 -1
- data/docs/LocaleDownloadCreateParameters.md +2 -2
- data/docs/LocalePreview1.md +1 -3
- data/docs/OrganizationJobTemplateCreateParameters.md +3 -1
- data/docs/OrganizationJobTemplateUpdateParameters.md +3 -1
- data/docs/ProjectCreateParameters.md +6 -2
- data/docs/ProjectDetails.md +7 -1
- data/docs/ProjectUpdateParameters.md +6 -2
- data/docs/RepoSyncExportParameters.md +19 -0
- data/docs/RepoSyncImportParameters.md +19 -0
- data/docs/RepoSyncsApi.md +8 -4
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/UploadBatch.md +29 -0
- data/docs/UploadBatchesApi.md +72 -0
- data/docs/UploadBatchesCreateParameters.md +21 -0
- data/docs/VersionsHistoryApi.md +5 -3
- data/lib/phrase/api/repo_syncs_api.rb +10 -2
- data/lib/phrase/api/upload_batches_api.rb +84 -0
- data/lib/phrase/api/versions_history_api.rb +6 -3
- data/lib/phrase/configuration.rb +5 -1
- data/lib/phrase/models/job_create_parameters.rb +14 -4
- data/lib/phrase/models/job_template_create_parameters.rb +14 -4
- data/lib/phrase/models/job_template_update_parameters.rb +14 -4
- data/lib/phrase/models/job_update_parameters.rb +14 -4
- data/lib/phrase/models/locale_download_create_parameters.rb +1 -1
- data/lib/phrase/models/locale_preview1.rb +4 -13
- data/lib/phrase/models/organization_job_template_create_parameters.rb +14 -4
- data/lib/phrase/models/organization_job_template_update_parameters.rb +14 -4
- data/lib/phrase/models/project_create_parameters.rb +26 -4
- data/lib/phrase/models/project_details.rb +33 -4
- data/lib/phrase/models/project_update_parameters.rb +26 -4
- data/lib/phrase/models/repo_sync_export_parameters.rb +207 -0
- data/lib/phrase/models/repo_sync_import_parameters.rb +207 -0
- data/lib/phrase/models/upload_batch.rb +288 -0
- data/lib/phrase/models/upload_batches_create_parameters.rb +224 -0
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +5 -0
- data/spec/api/repo_syncs_api_spec.rb +2 -0
- data/spec/api/upload_batches_api_spec.rb +37 -0
- data/spec/api/versions_history_api_spec.rb +2 -1
- data/spec/models/job_create_parameters_spec.rb +6 -0
- data/spec/models/job_template_create_parameters_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/locale_preview1_spec.rb +0 -6
- data/spec/models/organization_job_template_create_parameters_spec.rb +6 -0
- data/spec/models/organization_job_template_update_parameters_spec.rb +6 -0
- data/spec/models/project_create_parameters_spec.rb +12 -0
- data/spec/models/project_details_spec.rb +18 -0
- data/spec/models/project_update_parameters_spec.rb +12 -0
- data/spec/models/repo_sync_export_parameters_spec.rb +35 -0
- data/spec/models/repo_sync_import_parameters_spec.rb +35 -0
- data/spec/models/upload_batch_spec.rb +69 -0
- data/spec/models/upload_batches_create_parameters_spec.rb +41 -0
- metadata +258 -238
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.18.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.18.0.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./phrase-4.
|
|
62
|
+
(for development, run `gem install --dev ./phrase-4.18.0.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
## Getting Started
|
|
65
65
|
|
|
@@ -395,6 +395,7 @@ Class | Method | HTTP request | Description
|
|
|
395
395
|
*Phrase::TranslationsApi* | [**translations_unreview_collection**](docs/TranslationsApi.md#translations_unreview_collection) | **PATCH** /projects/{project_id}/translations/unreview | Unreview translations selected by query
|
|
396
396
|
*Phrase::TranslationsApi* | [**translations_unverify_collection**](docs/TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
|
|
397
397
|
*Phrase::TranslationsApi* | [**translations_verify_collection**](docs/TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
|
|
398
|
+
*Phrase::UploadBatchesApi* | [**upload_batches_create**](docs/UploadBatchesApi.md#upload_batches_create) | **POST** /projects/{project_id}/upload_batches | Create upload batch
|
|
398
399
|
*Phrase::UploadsApi* | [**upload_create**](docs/UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
|
|
399
400
|
*Phrase::UploadsApi* | [**upload_show**](docs/UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | Get a single upload
|
|
400
401
|
*Phrase::UploadsApi* | [**uploads_list**](docs/UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
|
|
@@ -575,6 +576,8 @@ Class | Method | HTTP request | Description
|
|
|
575
576
|
- [Phrase::ReleaseUpdateParameters1](docs/ReleaseUpdateParameters1.md)
|
|
576
577
|
- [Phrase::RepoSync](docs/RepoSync.md)
|
|
577
578
|
- [Phrase::RepoSyncEvent](docs/RepoSyncEvent.md)
|
|
579
|
+
- [Phrase::RepoSyncExportParameters](docs/RepoSyncExportParameters.md)
|
|
580
|
+
- [Phrase::RepoSyncImportParameters](docs/RepoSyncImportParameters.md)
|
|
578
581
|
- [Phrase::Screenshot](docs/Screenshot.md)
|
|
579
582
|
- [Phrase::ScreenshotMarker](docs/ScreenshotMarker.md)
|
|
580
583
|
- [Phrase::ScreenshotMarkerCreateParameters](docs/ScreenshotMarkerCreateParameters.md)
|
|
@@ -629,6 +632,8 @@ Class | Method | HTTP request | Description
|
|
|
629
632
|
- [Phrase::TranslationsUnverifyParameters](docs/TranslationsUnverifyParameters.md)
|
|
630
633
|
- [Phrase::TranslationsVerifyParameters](docs/TranslationsVerifyParameters.md)
|
|
631
634
|
- [Phrase::Upload](docs/Upload.md)
|
|
635
|
+
- [Phrase::UploadBatch](docs/UploadBatch.md)
|
|
636
|
+
- [Phrase::UploadBatchesCreateParameters](docs/UploadBatchesCreateParameters.md)
|
|
632
637
|
- [Phrase::UploadSummary](docs/UploadSummary.md)
|
|
633
638
|
- [Phrase::User](docs/User.md)
|
|
634
639
|
- [Phrase::UserPreview](docs/UserPreview.md)
|
data/docs/JobCreateParameters.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**tags** | **Array<String>** | tags of keys that should be included within the job | [optional]
|
|
14
14
|
**translation_key_ids** | **Array<String>** | ids of keys that should be included within the job | [optional]
|
|
15
15
|
**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. | [optional]
|
|
16
|
+
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
16
17
|
|
|
17
18
|
## Code Sample
|
|
18
19
|
|
|
@@ -27,7 +28,8 @@ instance = Phrase::JobCreateParameters.new(branch: my-feature-branch,
|
|
|
27
28
|
ticket_url: https://example.atlassian.net/browse/FOO,
|
|
28
29
|
tags: ["myUploadTag"],
|
|
29
30
|
translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
30
|
-
job_template_id: abcd1234cdef1234abcd1234cdef1234
|
|
31
|
+
job_template_id: abcd1234cdef1234abcd1234cdef1234,
|
|
32
|
+
autotranslate: true)
|
|
31
33
|
```
|
|
32
34
|
|
|
33
35
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**name** | **String** | Job template name |
|
|
9
9
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
10
|
+
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
10
11
|
|
|
11
12
|
## Code Sample
|
|
12
13
|
|
|
@@ -15,7 +16,8 @@ require 'Phrase'
|
|
|
15
16
|
|
|
16
17
|
instance = Phrase::JobTemplateCreateParameters.new(branch: my-feature-branch,
|
|
17
18
|
name: template,
|
|
18
|
-
briefing: text
|
|
19
|
+
briefing: text,
|
|
20
|
+
autotranslate: true)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
23
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**name** | **String** | Job template name |
|
|
9
9
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
10
|
+
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
10
11
|
|
|
11
12
|
## Code Sample
|
|
12
13
|
|
|
@@ -15,7 +16,8 @@ require 'Phrase'
|
|
|
15
16
|
|
|
16
17
|
instance = Phrase::JobTemplateUpdateParameters.new(branch: my-feature-branch,
|
|
17
18
|
name: template,
|
|
18
|
-
briefing: text
|
|
19
|
+
briefing: text,
|
|
20
|
+
autotranslate: true)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
23
|
|
data/docs/JobUpdateParameters.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
10
10
|
**due_date** | **Time** | Date the job should be finished | [optional]
|
|
11
11
|
**ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional]
|
|
12
|
+
**autotranslate** | **Boolean** | Automatically translate the job using machine translation | [optional]
|
|
12
13
|
|
|
13
14
|
## Code Sample
|
|
14
15
|
|
|
@@ -19,7 +20,8 @@ instance = Phrase::JobUpdateParameters.new(branch: my-feature-branch,
|
|
|
19
20
|
name: de,
|
|
20
21
|
briefing: de-DE,
|
|
21
22
|
due_date: null,
|
|
22
|
-
ticket_url: https://example.atlassian.net/browse/FOO
|
|
23
|
+
ticket_url: https://example.atlassian.net/browse/FOO,
|
|
24
|
+
autotranslate: true)
|
|
23
25
|
```
|
|
24
26
|
|
|
25
27
|
|
data/docs/KeyCreateParameters.md
CHANGED
|
@@ -38,7 +38,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
|
|
|
38
38
|
data_type: number,
|
|
39
39
|
tags: awesome-feature,needs-proofreading,
|
|
40
40
|
max_characters_allowed: 140,
|
|
41
|
-
screenshot: [B@
|
|
41
|
+
screenshot: [B@5531484a,
|
|
42
42
|
remove_screenshot: null,
|
|
43
43
|
unformatted: null,
|
|
44
44
|
default_translation_content: Default translation content,
|
data/docs/KeyUpdateParameters.md
CHANGED
|
@@ -36,7 +36,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
|
|
|
36
36
|
data_type: number,
|
|
37
37
|
tags: awesome-feature,needs-proofreading,
|
|
38
38
|
max_characters_allowed: 140,
|
|
39
|
-
screenshot: [B@
|
|
39
|
+
screenshot: [B@99caac2,
|
|
40
40
|
remove_screenshot: null,
|
|
41
41
|
unformatted: null,
|
|
42
42
|
xml_space_preserve: null,
|
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
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 [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format.
|
|
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. Pass format options as a JSON object with key-value pairs corresponding to the option name and value. For example, to include comments in a Gettext file, pass `{\"include_comments\": true}`. | [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]
|
|
@@ -34,7 +34,7 @@ instance = Phrase::LocaleDownloadCreateParameters.new(file_format: yml,
|
|
|
34
34
|
exclude_empty_zero_forms: true,
|
|
35
35
|
include_translated_keys: true,
|
|
36
36
|
keep_notranslate_tags: true,
|
|
37
|
-
format_options:
|
|
37
|
+
format_options: {"format_options":{"foo":"bar"}},
|
|
38
38
|
encoding: UTF-8,
|
|
39
39
|
include_unverified_translations: true,
|
|
40
40
|
use_last_reviewed_version: null,
|
data/docs/LocalePreview1.md
CHANGED
|
@@ -6,7 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | | [optional]
|
|
8
8
|
**code** | **String** | | [optional]
|
|
9
|
-
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
|
10
9
|
|
|
11
10
|
## Code Sample
|
|
12
11
|
|
|
@@ -14,8 +13,7 @@ Name | Type | Description | Notes
|
|
|
14
13
|
require 'Phrase'
|
|
15
14
|
|
|
16
15
|
instance = Phrase::LocalePreview1.new(name: null,
|
|
17
|
-
code: null
|
|
18
|
-
project: null)
|
|
16
|
+
code: null)
|
|
19
17
|
```
|
|
20
18
|
|
|
21
19
|
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Job template name |
|
|
8
8
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
9
|
+
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
9
10
|
|
|
10
11
|
## Code Sample
|
|
11
12
|
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
|
13
14
|
require 'Phrase'
|
|
14
15
|
|
|
15
16
|
instance = Phrase::OrganizationJobTemplateCreateParameters.new(name: template,
|
|
16
|
-
briefing: text
|
|
17
|
+
briefing: text,
|
|
18
|
+
autotranslate: true)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Job template name |
|
|
8
8
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
9
|
+
**autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional]
|
|
9
10
|
|
|
10
11
|
## Code Sample
|
|
11
12
|
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
|
13
14
|
require 'Phrase'
|
|
14
15
|
|
|
15
16
|
instance = Phrase::OrganizationJobTemplateUpdateParameters.new(name: template,
|
|
16
|
-
briefing: text
|
|
17
|
+
briefing: text,
|
|
18
|
+
autotranslate: true)
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
|
|
@@ -27,6 +27,8 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**autotranslate_mark_as_unverified** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
28
28
|
**autotranslate_use_machine_translation** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
29
29
|
**autotranslate_use_translation_memory** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
30
|
+
**autotranslate_overwrite_unverified_translations** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
31
|
+
**placeholder_styles** | **Array<String>** | (Optional) List of placeholder styles enabled for the project. | [optional]
|
|
30
32
|
|
|
31
33
|
## Code Sample
|
|
32
34
|
|
|
@@ -37,7 +39,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
|
|
|
37
39
|
main_format: yml,
|
|
38
40
|
media: Python,
|
|
39
41
|
shares_translation_memory: true,
|
|
40
|
-
project_image: [B@
|
|
42
|
+
project_image: [B@6026c754,
|
|
41
43
|
remove_project_image: null,
|
|
42
44
|
account_id: abcd1234,
|
|
43
45
|
point_of_contact: abcd1234,
|
|
@@ -55,7 +57,9 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
|
|
|
55
57
|
autotranslate_check_new_locales: true,
|
|
56
58
|
autotranslate_mark_as_unverified: true,
|
|
57
59
|
autotranslate_use_machine_translation: true,
|
|
58
|
-
autotranslate_use_translation_memory: true
|
|
60
|
+
autotranslate_use_translation_memory: true,
|
|
61
|
+
autotranslate_overwrite_unverified_translations: true,
|
|
62
|
+
placeholder_styles: ["angular","iOS"])
|
|
59
63
|
```
|
|
60
64
|
|
|
61
65
|
|
data/docs/ProjectDetails.md
CHANGED
|
@@ -30,6 +30,9 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**autotranslate_use_machine_translation** | **Boolean** | | [optional]
|
|
31
31
|
**autotranslate_use_translation_memory** | **Boolean** | | [optional]
|
|
32
32
|
**default_encoding** | **String** | | [optional]
|
|
33
|
+
**cldr_version** | **String** | | [optional]
|
|
34
|
+
**job_locking_enabled** | **Boolean** | | [optional]
|
|
35
|
+
**placeholder_styles** | **Array<String>** | | [optional]
|
|
33
36
|
|
|
34
37
|
## Code Sample
|
|
35
38
|
|
|
@@ -61,7 +64,10 @@ instance = Phrase::ProjectDetails.new(id: null,
|
|
|
61
64
|
autotranslate_mark_as_unverified: false,
|
|
62
65
|
autotranslate_use_machine_translation: false,
|
|
63
66
|
autotranslate_use_translation_memory: true,
|
|
64
|
-
default_encoding: UTF-8
|
|
67
|
+
default_encoding: UTF-8,
|
|
68
|
+
cldr_version: legacy,
|
|
69
|
+
job_locking_enabled: false,
|
|
70
|
+
placeholder_styles: ["angular","iOS"])
|
|
65
71
|
```
|
|
66
72
|
|
|
67
73
|
|
|
@@ -26,7 +26,9 @@ Name | Type | Description | Notes
|
|
|
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
|
+
**autotranslate_overwrite_unverified_translations** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
|
29
30
|
**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]
|
|
31
|
+
**placeholder_styles** | **Array<String>** | (Optional) List of placeholder styles enabled for the project. | [optional]
|
|
30
32
|
|
|
31
33
|
## Code Sample
|
|
32
34
|
|
|
@@ -39,7 +41,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
|
|
|
39
41
|
main_format: yml,
|
|
40
42
|
media: Python,
|
|
41
43
|
shares_translation_memory: true,
|
|
42
|
-
project_image: [B@
|
|
44
|
+
project_image: [B@3d7c21b7,
|
|
43
45
|
remove_project_image: false,
|
|
44
46
|
workflow: review,
|
|
45
47
|
machine_translation_enabled: true,
|
|
@@ -55,7 +57,9 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
|
|
|
55
57
|
autotranslate_mark_as_unverified: true,
|
|
56
58
|
autotranslate_use_machine_translation: true,
|
|
57
59
|
autotranslate_use_translation_memory: true,
|
|
58
|
-
|
|
60
|
+
autotranslate_overwrite_unverified_translations: true,
|
|
61
|
+
default_encoding: UTF-8,
|
|
62
|
+
placeholder_styles: ["angular","iOS"])
|
|
59
63
|
```
|
|
60
64
|
|
|
61
65
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Phrase::RepoSyncExportParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**pr_branch** | **String** | Source branch to open a pull request from | [optional]
|
|
8
|
+
**branch** | **String** | Strings branch to export from | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'Phrase'
|
|
14
|
+
|
|
15
|
+
instance = Phrase::RepoSyncExportParameters.new(pr_branch: my-feature-branch,
|
|
16
|
+
branch: my-strings-branch)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Phrase::RepoSyncImportParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**repository_branch** | **String** | Branch to import from | [optional]
|
|
8
|
+
**branch** | **String** | Strings branch to import to | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'Phrase'
|
|
14
|
+
|
|
15
|
+
instance = Phrase::RepoSyncImportParameters.new(repository_branch: my-feature-branch,
|
|
16
|
+
branch: my-strings-branch)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/RepoSyncsApi.md
CHANGED
|
@@ -167,7 +167,8 @@ api_instance = Phrase::RepoSyncsApi.new
|
|
|
167
167
|
account_id = 'account_id_example' # String | Account ID
|
|
168
168
|
id = 'id_example' # String | ID
|
|
169
169
|
opts = {
|
|
170
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
170
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
171
|
+
repo_sync_export_parameters: Phrase::RepoSyncExportParameters.new # RepoSyncExportParameters |
|
|
171
172
|
}
|
|
172
173
|
|
|
173
174
|
begin
|
|
@@ -187,6 +188,7 @@ Name | Type | Description | Notes
|
|
|
187
188
|
**account_id** | **String**| Account ID |
|
|
188
189
|
**id** | **String**| ID |
|
|
189
190
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
191
|
+
**repo_sync_export_parameters** | [**RepoSyncExportParameters**](RepoSyncExportParameters.md)| | [optional]
|
|
190
192
|
|
|
191
193
|
### Return type
|
|
192
194
|
|
|
@@ -198,7 +200,7 @@ Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
|
|
198
200
|
|
|
199
201
|
### HTTP request headers
|
|
200
202
|
|
|
201
|
-
- **Content-Type**:
|
|
203
|
+
- **Content-Type**: application/json
|
|
202
204
|
- **Accept**: application/json
|
|
203
205
|
|
|
204
206
|
|
|
@@ -230,7 +232,8 @@ api_instance = Phrase::RepoSyncsApi.new
|
|
|
230
232
|
account_id = 'account_id_example' # String | Account ID
|
|
231
233
|
id = 'id_example' # String | ID
|
|
232
234
|
opts = {
|
|
233
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
235
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
236
|
+
repo_sync_import_parameters: Phrase::RepoSyncImportParameters.new # RepoSyncImportParameters |
|
|
234
237
|
}
|
|
235
238
|
|
|
236
239
|
begin
|
|
@@ -250,6 +253,7 @@ Name | Type | Description | Notes
|
|
|
250
253
|
**account_id** | **String**| Account ID |
|
|
251
254
|
**id** | **String**| ID |
|
|
252
255
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
256
|
+
**repo_sync_import_parameters** | [**RepoSyncImportParameters**](RepoSyncImportParameters.md)| | [optional]
|
|
253
257
|
|
|
254
258
|
### Return type
|
|
255
259
|
|
|
@@ -261,7 +265,7 @@ Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
|
|
261
265
|
|
|
262
266
|
### HTTP request headers
|
|
263
267
|
|
|
264
|
-
- **Content-Type**:
|
|
268
|
+
- **Content-Type**: application/json
|
|
265
269
|
- **Accept**: application/json
|
|
266
270
|
|
|
267
271
|
|
data/docs/UploadBatch.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Phrase::UploadBatch
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**state** | **String** | Processing state of the upload batch | [optional]
|
|
8
|
+
**delete_unmentioned_keys** | **Boolean** | Indicates whether unmentioned keys will be deleted after processing all uploads in the batch | [optional]
|
|
9
|
+
**created_at** | **Time** | | [optional]
|
|
10
|
+
**updated_at** | **Time** | | [optional]
|
|
11
|
+
**project** | [**ProjectShort**](.md) | | [optional]
|
|
12
|
+
**user** | [**UserPreview**](.md) | | [optional]
|
|
13
|
+
**uploads** | [**Array<Upload>**](Upload.md) | | [optional]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'Phrase'
|
|
19
|
+
|
|
20
|
+
instance = Phrase::UploadBatch.new(state: null,
|
|
21
|
+
delete_unmentioned_keys: null,
|
|
22
|
+
created_at: null,
|
|
23
|
+
updated_at: null,
|
|
24
|
+
project: null,
|
|
25
|
+
user: null,
|
|
26
|
+
uploads: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Phrase::UploadBatchesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**upload_batches_create**](UploadBatchesApi.md#upload_batches_create) | **POST** /projects/{project_id}/upload_batches | Create upload batch
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## upload_batches_create
|
|
12
|
+
|
|
13
|
+
> UploadBatch upload_batches_create(project_id, upload_batches_create_parameters, opts)
|
|
14
|
+
|
|
15
|
+
Create upload batch
|
|
16
|
+
|
|
17
|
+
Groups multiple file uploads into a single batch. Optionally, launches the deletion of unmentioned translation keys after all uploads in the batch are completed.
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'phrase'
|
|
24
|
+
# setup authorization
|
|
25
|
+
Phrase.configure do |config|
|
|
26
|
+
# Configure HTTP basic authorization: Basic
|
|
27
|
+
config.username = 'YOUR USERNAME'
|
|
28
|
+
config.password = 'YOUR PASSWORD'
|
|
29
|
+
|
|
30
|
+
# Configure API key authorization: Token
|
|
31
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
32
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
api_instance = Phrase::UploadBatchesApi.new
|
|
36
|
+
project_id = 'project_id_example' # String | Project ID
|
|
37
|
+
upload_batches_create_parameters = Phrase::UploadBatchesCreateParameters.new({upload_ids: ["abcd1234cdef1234abcd1234cdef1234", "bcde2345defg2345bcde2345defg2345"]}) # UploadBatchesCreateParameters |
|
|
38
|
+
opts = {
|
|
39
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
#Create upload batch
|
|
44
|
+
result = api_instance.upload_batches_create(project_id, upload_batches_create_parameters, opts)
|
|
45
|
+
pp result
|
|
46
|
+
rescue Phrase::ApiError => e
|
|
47
|
+
puts "Exception when calling UploadBatchesApi->upload_batches_create: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
Name | Type | Description | Notes
|
|
55
|
+
------------- | ------------- | ------------- | -------------
|
|
56
|
+
**project_id** | **String**| Project ID |
|
|
57
|
+
**upload_batches_create_parameters** | [**UploadBatchesCreateParameters**](UploadBatchesCreateParameters.md)| |
|
|
58
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
Response<([**UploadBatch**](UploadBatch.md))>
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: application/json
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Phrase::UploadBatchesCreateParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
+
**delete_unmentioned_keys** | **Boolean** | If set to true, after all uploads in the batch are completed, translation keys that were not mentioned in any of the uploaded files will be deleted. | [optional]
|
|
9
|
+
**upload_ids** | **Array<String>** | Array of upload IDs to include in the batch |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'Phrase'
|
|
15
|
+
|
|
16
|
+
instance = Phrase::UploadBatchesCreateParameters.new(branch: my-feature-branch,
|
|
17
|
+
delete_unmentioned_keys: true,
|
|
18
|
+
upload_ids: ["abcd1234cdef1234abcd1234cdef1234","bcde2345defg2345bcde2345defg2345"])
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/VersionsHistoryApi.md
CHANGED
|
@@ -78,7 +78,7 @@ Response<([**TranslationVersionWithUser**](TranslationVersionWithUser.md))>
|
|
|
78
78
|
|
|
79
79
|
## versions_list
|
|
80
80
|
|
|
81
|
-
> Array<
|
|
81
|
+
> Array<TranslationVersionWithUser> versions_list(project_id, translation_id, opts)
|
|
82
82
|
|
|
83
83
|
List all versions
|
|
84
84
|
|
|
@@ -107,7 +107,8 @@ opts = {
|
|
|
107
107
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
108
108
|
page: 1, # Integer | Page number
|
|
109
109
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
110
|
-
branch: 'my-feature-branch' # String | specify the branch to use
|
|
110
|
+
branch: 'my-feature-branch', # String | specify the branch to use
|
|
111
|
+
only_content_updates: true # Boolean | Indicates whether only content updates should be returned
|
|
111
112
|
}
|
|
112
113
|
|
|
113
114
|
begin
|
|
@@ -130,10 +131,11 @@ Name | Type | Description | Notes
|
|
|
130
131
|
**page** | **Integer**| Page number | [optional]
|
|
131
132
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
132
133
|
**branch** | **String**| specify the branch to use | [optional]
|
|
134
|
+
**only_content_updates** | **Boolean**| Indicates whether only content updates should be returned | [optional] [default to false]
|
|
133
135
|
|
|
134
136
|
### Return type
|
|
135
137
|
|
|
136
|
-
Response<([**Array<
|
|
138
|
+
Response<([**Array<TranslationVersionWithUser>**](TranslationVersionWithUser.md))>
|
|
137
139
|
|
|
138
140
|
### Authorization
|
|
139
141
|
|
|
@@ -157,6 +157,7 @@ module Phrase
|
|
|
157
157
|
# @param id [String] ID
|
|
158
158
|
# @param [Hash] opts the optional parameters
|
|
159
159
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
160
|
+
# @option opts [RepoSyncExportParameters] :repo_sync_export_parameters
|
|
160
161
|
# @return [RepoSyncEvent]
|
|
161
162
|
def repo_sync_export(account_id, id, opts = {})
|
|
162
163
|
data, _status_code, _headers = repo_sync_export_with_http_info(account_id, id, opts)
|
|
@@ -169,6 +170,7 @@ module Phrase
|
|
|
169
170
|
# @param id [String] ID
|
|
170
171
|
# @param [Hash] opts the optional parameters
|
|
171
172
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
173
|
+
# @option opts [RepoSyncExportParameters] :repo_sync_export_parameters
|
|
172
174
|
# @return [Array<(Response<(RepoSyncEvent)>, Integer, Hash)>] Response<(RepoSyncEvent)> data, response status code and response headers
|
|
173
175
|
def repo_sync_export_with_http_info(account_id, id, opts = {})
|
|
174
176
|
if @api_client.config.debugging
|
|
@@ -192,13 +194,15 @@ module Phrase
|
|
|
192
194
|
header_params = opts[:header_params] || {}
|
|
193
195
|
# HTTP header 'Accept' (if needed)
|
|
194
196
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
197
|
+
# HTTP header 'Content-Type'
|
|
198
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
195
199
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
196
200
|
|
|
197
201
|
# form parameters
|
|
198
202
|
form_params = opts[:form_params] || {}
|
|
199
203
|
|
|
200
204
|
# http body (model)
|
|
201
|
-
post_body = opts[:body]
|
|
205
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'repo_sync_export_parameters'])
|
|
202
206
|
|
|
203
207
|
# return_type
|
|
204
208
|
return_type = opts[:return_type] || 'RepoSyncEvent'
|
|
@@ -229,6 +233,7 @@ module Phrase
|
|
|
229
233
|
# @param id [String] ID
|
|
230
234
|
# @param [Hash] opts the optional parameters
|
|
231
235
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
236
|
+
# @option opts [RepoSyncImportParameters] :repo_sync_import_parameters
|
|
232
237
|
# @return [RepoSyncEvent]
|
|
233
238
|
def repo_sync_import(account_id, id, opts = {})
|
|
234
239
|
data, _status_code, _headers = repo_sync_import_with_http_info(account_id, id, opts)
|
|
@@ -241,6 +246,7 @@ module Phrase
|
|
|
241
246
|
# @param id [String] ID
|
|
242
247
|
# @param [Hash] opts the optional parameters
|
|
243
248
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
249
|
+
# @option opts [RepoSyncImportParameters] :repo_sync_import_parameters
|
|
244
250
|
# @return [Array<(Response<(RepoSyncEvent)>, Integer, Hash)>] Response<(RepoSyncEvent)> data, response status code and response headers
|
|
245
251
|
def repo_sync_import_with_http_info(account_id, id, opts = {})
|
|
246
252
|
if @api_client.config.debugging
|
|
@@ -264,13 +270,15 @@ module Phrase
|
|
|
264
270
|
header_params = opts[:header_params] || {}
|
|
265
271
|
# HTTP header 'Accept' (if needed)
|
|
266
272
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
273
|
+
# HTTP header 'Content-Type'
|
|
274
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
267
275
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
268
276
|
|
|
269
277
|
# form parameters
|
|
270
278
|
form_params = opts[:form_params] || {}
|
|
271
279
|
|
|
272
280
|
# http body (model)
|
|
273
|
-
post_body = opts[:body]
|
|
281
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'repo_sync_import_parameters'])
|
|
274
282
|
|
|
275
283
|
# return_type
|
|
276
284
|
return_type = opts[:return_type] || 'RepoSyncEvent'
|