phrase 2.15.0 → 2.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +3 -3
- data/docs/LocalesApi.md +8 -8
- data/docs/TranslationsApi.md +2 -2
- data/docs/UploadCreateParameters.md +3 -1
- data/docs/UploadsApi.md +3 -1
- data/lib/phrase/api/locales_api.rb +8 -8
- data/lib/phrase/api/translations_api.rb +2 -2
- data/lib/phrase/api/uploads_api.rb +3 -0
- data/lib/phrase/models/upload_create_parameters.rb +16 -4
- data/lib/phrase/version.rb +1 -1
- data/spec/api/locales_api_spec.rb +4 -4
- data/spec/api/translations_api_spec.rb +1 -1
- data/spec/api/uploads_api_spec.rb +1 -0
- data/spec/models/upload_create_parameters_spec.rb +6 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cc5274b2e42f539a10f7260663c5cbfd5f5c6c3fca1265150c74d60ecc0ee6da
|
4
|
+
data.tar.gz: 46ef9968f4ffa0d0a5b6de4c7cbcba4331a5a1484c30fba03188f691bcc7369f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cacdd9077b60519f829f29fda5e7a91acac0eeb91e2e610fd3e823209725dc98ca129dbfbbe73b3a7d086409b597591c4dde4143d3a3e856f048b9c832d57f83
|
7
|
+
data.tar.gz: 5b89f88f5cb4b00b805216d26fb6de02bc350d451558f8bb05e05087a9aa27a65e21542fdbd6367d2604e044b5b48b771024f7e6a7d4ff0fe6159ec82f9117fc
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [2.16.0](https://github.com/phrase/openapi/compare/ruby-v2.15.0...ruby-v2.16.0) (2023-09-12)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* Optionally tag only affected keys on upload [TSI-2041] ([#412](https://github.com/phrase/openapi/issues/412)) ([e8f958e](https://github.com/phrase/openapi/commit/e8f958e91469c2542f44ab68469c933688958383))
|
9
|
+
* **TSI-1946:** Add reviewed_at to translations ([#396](https://github.com/phrase/openapi/issues/396)) ([3e663d9](https://github.com/phrase/openapi/commit/3e663d971a99a816f0165dd6653a9a1e8a87c95e))
|
10
|
+
|
3
11
|
## [2.15.0](https://github.com/phrase/openapi/compare/ruby-v2.14.0...ruby-v2.15.0) (2023-08-28)
|
4
12
|
|
5
13
|
|
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: 2.
|
10
|
+
- Package version: 2.16.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-2.
|
59
|
+
gem install ./phrase-2.16.0.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.
|
62
|
+
(for development, run `gem install --dev ./phrase-2.16.0.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
data/docs/LocalesApi.md
CHANGED
@@ -168,7 +168,7 @@ end
|
|
168
168
|
|
169
169
|
api_instance = Phrase::LocalesApi.new
|
170
170
|
project_id = 'project_id_example' # String | Project ID
|
171
|
-
id = 'id_example' # String | ID
|
171
|
+
id = 'id_example' # String | Locale ID or locale name
|
172
172
|
opts = {
|
173
173
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
174
174
|
branch: 'my-feature-branch' # String | specify the branch to use
|
@@ -188,7 +188,7 @@ end
|
|
188
188
|
Name | Type | Description | Notes
|
189
189
|
------------- | ------------- | ------------- | -------------
|
190
190
|
**project_id** | **String**| Project ID |
|
191
|
-
**id** | **String**| ID |
|
191
|
+
**id** | **String**| Locale ID or locale name |
|
192
192
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
193
193
|
**branch** | **String**| specify the branch to use | [optional]
|
194
194
|
|
@@ -232,7 +232,7 @@ end
|
|
232
232
|
|
233
233
|
api_instance = Phrase::LocalesApi.new
|
234
234
|
project_id = 'project_id_example' # String | Project ID
|
235
|
-
id = 'id_example' # String | ID
|
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
238
|
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
@@ -270,7 +270,7 @@ end
|
|
270
270
|
Name | Type | Description | Notes
|
271
271
|
------------- | ------------- | ------------- | -------------
|
272
272
|
**project_id** | **String**| Project ID |
|
273
|
-
**id** | **String**| ID |
|
273
|
+
**id** | **String**| Locale ID or locale name |
|
274
274
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
275
275
|
**if_modified_since** | **String**| Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
276
276
|
**if_none_match** | **String**| ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
@@ -331,7 +331,7 @@ end
|
|
331
331
|
|
332
332
|
api_instance = Phrase::LocalesApi.new
|
333
333
|
project_id = 'project_id_example' # String | Project ID
|
334
|
-
id = 'id_example' # String | ID
|
334
|
+
id = 'id_example' # String | Locale ID or locale name
|
335
335
|
opts = {
|
336
336
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
337
337
|
branch: 'my-feature-branch' # String | specify the branch to use
|
@@ -352,7 +352,7 @@ end
|
|
352
352
|
Name | Type | Description | Notes
|
353
353
|
------------- | ------------- | ------------- | -------------
|
354
354
|
**project_id** | **String**| Project ID |
|
355
|
-
**id** | **String**| ID |
|
355
|
+
**id** | **String**| Locale ID or locale name |
|
356
356
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
357
357
|
**branch** | **String**| specify the branch to use | [optional]
|
358
358
|
|
@@ -396,7 +396,7 @@ end
|
|
396
396
|
|
397
397
|
api_instance = Phrase::LocalesApi.new
|
398
398
|
project_id = 'project_id_example' # String | Project ID
|
399
|
-
id = 'id_example' # String | ID
|
399
|
+
id = 'id_example' # String | Locale ID or locale name
|
400
400
|
locale_update_parameters = Phrase::LocaleUpdateParameters.new # LocaleUpdateParameters |
|
401
401
|
opts = {
|
402
402
|
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
@@ -417,7 +417,7 @@ end
|
|
417
417
|
Name | Type | Description | Notes
|
418
418
|
------------- | ------------- | ------------- | -------------
|
419
419
|
**project_id** | **String**| Project ID |
|
420
|
-
**id** | **String**| ID |
|
420
|
+
**id** | **String**| Locale ID or locale name |
|
421
421
|
**locale_update_parameters** | [**LocaleUpdateParameters**](LocaleUpdateParameters.md)| |
|
422
422
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
423
423
|
|
data/docs/TranslationsApi.md
CHANGED
@@ -853,7 +853,7 @@ opts = {
|
|
853
853
|
branch: 'my-feature-branch', # String | specify the branch to use
|
854
854
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
855
855
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
856
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
856
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
857
857
|
}
|
858
858
|
|
859
859
|
begin
|
@@ -879,7 +879,7 @@ Name | Type | Description | Notes
|
|
879
879
|
**branch** | **String**| specify the branch to use | [optional]
|
880
880
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
881
881
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
882
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
882
|
+
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
883
883
|
|
884
884
|
### Return type
|
885
885
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
19
19
|
**format_options** | [**Object**](.md) | Additional options available for specific formats. See our format guide for complete list. | [optional]
|
20
20
|
**autotranslate** | **Boolean** | If set, translations for the uploaded language will be fetched automatically. | [optional]
|
21
21
|
**mark_reviewed** | **Boolean** | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. | [optional]
|
22
|
+
**tag_only_affected_keys** | **Boolean** | Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false` | [optional] [default to false]
|
22
23
|
|
23
24
|
## Code Sample
|
24
25
|
|
@@ -39,7 +40,8 @@ instance = Phrase::UploadCreateParameters.new(branch: my-feature-branch,
|
|
39
40
|
locale_mapping: {"en": "2"},
|
40
41
|
format_options: {"foo": "bar"},
|
41
42
|
autotranslate: null,
|
42
|
-
mark_reviewed: null
|
43
|
+
mark_reviewed: null,
|
44
|
+
tag_only_affected_keys: null)
|
43
45
|
```
|
44
46
|
|
45
47
|
|
data/docs/UploadsApi.md
CHANGED
@@ -52,7 +52,8 @@ opts = {
|
|
52
52
|
locale_mapping: nil, # Object | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
|
53
53
|
format_options: nil, # Object | Additional options available for specific formats. See our format guide for complete list.
|
54
54
|
autotranslate: true, # Boolean | If set, translations for the uploaded language will be fetched automatically.
|
55
|
-
mark_reviewed: true # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
|
55
|
+
mark_reviewed: true, # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
|
56
|
+
tag_only_affected_keys: false # Boolean | Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
|
56
57
|
}
|
57
58
|
|
58
59
|
begin
|
@@ -86,6 +87,7 @@ Name | Type | Description | Notes
|
|
86
87
|
**format_options** | [**Object**](Object.md)| Additional options available for specific formats. See our format guide for complete list. | [optional]
|
87
88
|
**autotranslate** | **Boolean**| If set, translations for the uploaded language will be fetched automatically. | [optional]
|
88
89
|
**mark_reviewed** | **Boolean**| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. | [optional]
|
90
|
+
**tag_only_affected_keys** | **Boolean**| Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false` | [optional] [default to false]
|
89
91
|
|
90
92
|
### Return type
|
91
93
|
|
@@ -156,7 +156,7 @@ module Phrase
|
|
156
156
|
# Delete a locale
|
157
157
|
# Delete an existing locale.
|
158
158
|
# @param project_id [String] Project ID
|
159
|
-
# @param id [String] ID
|
159
|
+
# @param id [String] Locale ID or locale name
|
160
160
|
# @param [Hash] opts the optional parameters
|
161
161
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
162
162
|
# @option opts [String] :branch specify the branch to use
|
@@ -169,7 +169,7 @@ module Phrase
|
|
169
169
|
# Delete a locale
|
170
170
|
# Delete an existing locale.
|
171
171
|
# @param project_id [String] Project ID
|
172
|
-
# @param id [String] ID
|
172
|
+
# @param id [String] Locale ID or locale name
|
173
173
|
# @param [Hash] opts the optional parameters
|
174
174
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
175
175
|
# @option opts [String] :branch specify the branch to use
|
@@ -229,7 +229,7 @@ module Phrase
|
|
229
229
|
# Download a locale
|
230
230
|
# Download a locale in a specific file format.
|
231
231
|
# @param project_id [String] Project ID
|
232
|
-
# @param id [String] ID
|
232
|
+
# @param id [String] Locale ID or locale name
|
233
233
|
# @param [Hash] opts the optional parameters
|
234
234
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
235
235
|
# @option opts [String] :if_modified_since Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
@@ -259,7 +259,7 @@ module Phrase
|
|
259
259
|
# Download a locale
|
260
260
|
# Download a locale in a specific file format.
|
261
261
|
# @param project_id [String] Project ID
|
262
|
-
# @param id [String] ID
|
262
|
+
# @param id [String] Locale ID or locale name
|
263
263
|
# @param [Hash] opts the optional parameters
|
264
264
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
265
265
|
# @option opts [String] :if_modified_since Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
@@ -355,7 +355,7 @@ module Phrase
|
|
355
355
|
# Get a single locale
|
356
356
|
# Get details on a single locale for a given project.
|
357
357
|
# @param project_id [String] Project ID
|
358
|
-
# @param id [String] ID
|
358
|
+
# @param id [String] Locale ID or locale name
|
359
359
|
# @param [Hash] opts the optional parameters
|
360
360
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
361
361
|
# @option opts [String] :branch specify the branch to use
|
@@ -368,7 +368,7 @@ module Phrase
|
|
368
368
|
# Get a single locale
|
369
369
|
# Get details on a single locale for a given project.
|
370
370
|
# @param project_id [String] Project ID
|
371
|
-
# @param id [String] ID
|
371
|
+
# @param id [String] Locale ID or locale name
|
372
372
|
# @param [Hash] opts the optional parameters
|
373
373
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
374
374
|
# @option opts [String] :branch specify the branch to use
|
@@ -430,7 +430,7 @@ module Phrase
|
|
430
430
|
# Update a locale
|
431
431
|
# Update an existing locale.
|
432
432
|
# @param project_id [String] Project ID
|
433
|
-
# @param id [String] ID
|
433
|
+
# @param id [String] Locale ID or locale name
|
434
434
|
# @param locale_update_parameters [LocaleUpdateParameters]
|
435
435
|
# @param [Hash] opts the optional parameters
|
436
436
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
@@ -443,7 +443,7 @@ module Phrase
|
|
443
443
|
# Update a locale
|
444
444
|
# Update an existing locale.
|
445
445
|
# @param project_id [String] Project ID
|
446
|
-
# @param id [String] ID
|
446
|
+
# @param id [String] Locale ID or locale name
|
447
447
|
# @param locale_update_parameters [LocaleUpdateParameters]
|
448
448
|
# @param [Hash] opts the optional parameters
|
449
449
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
@@ -976,7 +976,7 @@ module Phrase
|
|
976
976
|
# @option opts [String] :branch specify the branch to use
|
977
977
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
978
978
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
979
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
979
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
980
980
|
# @return [Array<Translation>]
|
981
981
|
def translations_list(project_id, opts = {})
|
982
982
|
data, _status_code, _headers = translations_list_with_http_info(project_id, opts)
|
@@ -995,7 +995,7 @@ module Phrase
|
|
995
995
|
# @option opts [String] :branch specify the branch to use
|
996
996
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
997
997
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
998
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
998
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
999
999
|
# @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
|
1000
1000
|
def translations_list_with_http_info(project_id, opts = {})
|
1001
1001
|
if @api_client.config.debugging
|
@@ -27,6 +27,7 @@ module Phrase
|
|
27
27
|
# @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
|
28
28
|
# @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
|
29
29
|
# @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
|
30
|
+
# @option opts [Boolean] :tag_only_affected_keys Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false` (default to false)
|
30
31
|
# @return [Upload]
|
31
32
|
def upload_create(project_id, opts = {})
|
32
33
|
data, _status_code, _headers = upload_create_with_http_info(project_id, opts)
|
@@ -53,6 +54,7 @@ module Phrase
|
|
53
54
|
# @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
|
54
55
|
# @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
|
55
56
|
# @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
|
57
|
+
# @option opts [Boolean] :tag_only_affected_keys Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
|
56
58
|
# @return [Array<(Response<(Upload)>, Integer, Hash)>] Response<(Upload)> data, response status code and response headers
|
57
59
|
def upload_create_with_http_info(project_id, opts = {})
|
58
60
|
if @api_client.config.debugging
|
@@ -93,6 +95,7 @@ module Phrase
|
|
93
95
|
form_params['format_options'] = opts[:'format_options'] if !opts[:'format_options'].nil?
|
94
96
|
form_params['autotranslate'] = opts[:'autotranslate'] if !opts[:'autotranslate'].nil?
|
95
97
|
form_params['mark_reviewed'] = opts[:'mark_reviewed'] if !opts[:'mark_reviewed'].nil?
|
98
|
+
form_params['tag_only_affected_keys'] = opts[:'tag_only_affected_keys'] if !opts[:'tag_only_affected_keys'].nil?
|
96
99
|
|
97
100
|
# http body (model)
|
98
101
|
post_body = opts[:body]
|
@@ -47,6 +47,9 @@ module Phrase
|
|
47
47
|
# Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
|
48
48
|
attr_accessor :mark_reviewed
|
49
49
|
|
50
|
+
# Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
|
51
|
+
attr_accessor :tag_only_affected_keys
|
52
|
+
|
50
53
|
# Attribute mapping from ruby-style variable name to JSON key.
|
51
54
|
def self.attribute_map
|
52
55
|
{
|
@@ -64,7 +67,8 @@ module Phrase
|
|
64
67
|
:'locale_mapping' => :'locale_mapping',
|
65
68
|
:'format_options' => :'format_options',
|
66
69
|
:'autotranslate' => :'autotranslate',
|
67
|
-
:'mark_reviewed' => :'mark_reviewed'
|
70
|
+
:'mark_reviewed' => :'mark_reviewed',
|
71
|
+
:'tag_only_affected_keys' => :'tag_only_affected_keys'
|
68
72
|
}
|
69
73
|
end
|
70
74
|
|
@@ -85,7 +89,8 @@ module Phrase
|
|
85
89
|
:'locale_mapping' => :'Object',
|
86
90
|
:'format_options' => :'Object',
|
87
91
|
:'autotranslate' => :'Boolean',
|
88
|
-
:'mark_reviewed' => :'Boolean'
|
92
|
+
:'mark_reviewed' => :'Boolean',
|
93
|
+
:'tag_only_affected_keys' => :'Boolean'
|
89
94
|
}
|
90
95
|
end
|
91
96
|
|
@@ -169,6 +174,12 @@ module Phrase
|
|
169
174
|
if attributes.key?(:'mark_reviewed')
|
170
175
|
self.mark_reviewed = attributes[:'mark_reviewed']
|
171
176
|
end
|
177
|
+
|
178
|
+
if attributes.key?(:'tag_only_affected_keys')
|
179
|
+
self.tag_only_affected_keys = attributes[:'tag_only_affected_keys']
|
180
|
+
else
|
181
|
+
self.tag_only_affected_keys = false
|
182
|
+
end
|
172
183
|
end
|
173
184
|
|
174
185
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -203,7 +214,8 @@ module Phrase
|
|
203
214
|
locale_mapping == o.locale_mapping &&
|
204
215
|
format_options == o.format_options &&
|
205
216
|
autotranslate == o.autotranslate &&
|
206
|
-
mark_reviewed == o.mark_reviewed
|
217
|
+
mark_reviewed == o.mark_reviewed &&
|
218
|
+
tag_only_affected_keys == o.tag_only_affected_keys
|
207
219
|
end
|
208
220
|
|
209
221
|
# @see the `==` method
|
@@ -215,7 +227,7 @@ module Phrase
|
|
215
227
|
# Calculates hash code according to all attributes.
|
216
228
|
# @return [Integer] Hash code
|
217
229
|
def hash
|
218
|
-
[branch, file, file_format, locale_id, tags, update_translations, update_descriptions, convert_emoji, skip_upload_tags, skip_unverification, file_encoding, locale_mapping, format_options, autotranslate, mark_reviewed].hash
|
230
|
+
[branch, file, file_format, locale_id, tags, update_translations, update_descriptions, convert_emoji, skip_upload_tags, skip_unverification, file_encoding, locale_mapping, format_options, autotranslate, mark_reviewed, tag_only_affected_keys].hash
|
219
231
|
end
|
220
232
|
|
221
233
|
# Builds the object from hash
|
data/lib/phrase/version.rb
CHANGED
@@ -53,7 +53,7 @@ describe 'LocalesApi' do
|
|
53
53
|
# Delete a locale
|
54
54
|
# Delete an existing locale.
|
55
55
|
# @param project_id Project ID
|
56
|
-
# @param id ID
|
56
|
+
# @param id Locale ID or locale name
|
57
57
|
# @param [Hash] opts the optional parameters
|
58
58
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
59
59
|
# @option opts [String] :branch specify the branch to use
|
@@ -68,7 +68,7 @@ describe 'LocalesApi' do
|
|
68
68
|
# Download a locale
|
69
69
|
# Download a locale in a specific file format.
|
70
70
|
# @param project_id Project ID
|
71
|
-
# @param id ID
|
71
|
+
# @param id Locale ID or locale name
|
72
72
|
# @param [Hash] opts the optional parameters
|
73
73
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
74
74
|
# @option opts [String] :if_modified_since Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
@@ -100,7 +100,7 @@ describe 'LocalesApi' do
|
|
100
100
|
# Get a single locale
|
101
101
|
# Get details on a single locale for a given project.
|
102
102
|
# @param project_id Project ID
|
103
|
-
# @param id ID
|
103
|
+
# @param id Locale ID or locale name
|
104
104
|
# @param [Hash] opts the optional parameters
|
105
105
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
106
106
|
# @option opts [String] :branch specify the branch to use
|
@@ -115,7 +115,7 @@ describe 'LocalesApi' do
|
|
115
115
|
# Update a locale
|
116
116
|
# Update an existing locale.
|
117
117
|
# @param project_id Project ID
|
118
|
-
# @param id ID
|
118
|
+
# @param id Locale ID or locale name
|
119
119
|
# @param locale_update_parameters
|
120
120
|
# @param [Hash] opts the optional parameters
|
121
121
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
@@ -220,7 +220,7 @@ describe 'TranslationsApi' do
|
|
220
220
|
# @option opts [String] :branch specify the branch to use
|
221
221
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
222
222
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
223
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
223
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
224
224
|
# @return [Array<Translation>]
|
225
225
|
describe 'translations_list test' do
|
226
226
|
it 'should work' do
|
@@ -41,6 +41,7 @@ describe 'UploadsApi' do
|
|
41
41
|
# @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
|
42
42
|
# @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
|
43
43
|
# @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
|
44
|
+
# @option opts [Boolean] :tag_only_affected_keys Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
|
44
45
|
# @return [Upload]
|
45
46
|
describe 'upload_create test' do
|
46
47
|
it 'should work' do
|
@@ -110,4 +110,10 @@ describe 'UploadCreateParameters' do
|
|
110
110
|
end
|
111
111
|
end
|
112
112
|
|
113
|
+
describe 'test attribute "tag_only_affected_keys"' do
|
114
|
+
it 'should work' do
|
115
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
113
119
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: phrase
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.
|
4
|
+
version: 2.16.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Phrase
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-09-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|