phrase 4.4.0 → 4.5.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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +7 -5
  4. data/docs/CommentRepliesApi.md +3 -5
  5. data/docs/CommentsApi.md +3 -5
  6. data/docs/KeyCreateParameters.md +1 -1
  7. data/docs/KeyUpdateParameters.md +1 -1
  8. data/docs/ProjectCreateParameters.md +1 -1
  9. data/docs/ProjectUpdateParameters.md +1 -1
  10. data/docs/ScreenshotUpdateParameters.md +1 -1
  11. data/docs/TranslationUnreviewParameters.md +17 -0
  12. data/docs/TranslationsApi.md +130 -0
  13. data/docs/TranslationsUnreviewParameters.md +19 -0
  14. data/docs/UploadSummary.md +5 -1
  15. data/docs/UploadsApi.md +2 -0
  16. data/lib/phrase/api/comment_replies_api.rb +4 -12
  17. data/lib/phrase/api/comments_api.rb +4 -12
  18. data/lib/phrase/api/translations_api.rb +154 -0
  19. data/lib/phrase/api/uploads_api.rb +3 -0
  20. data/lib/phrase/models/{comments_list_parameters.rb → translation_unreview_parameters.rb} +8 -52
  21. data/lib/phrase/models/{replies_list_parameters.rb → translations_unreview_parameters.rb} +12 -34
  22. data/lib/phrase/models/upload_summary.rb +22 -4
  23. data/lib/phrase/version.rb +1 -1
  24. data/lib/phrase.rb +2 -2
  25. data/spec/api/comment_replies_api_spec.rb +0 -1
  26. data/spec/api/comments_api_spec.rb +0 -1
  27. data/spec/api/translations_api_spec.rb +29 -0
  28. data/spec/models/translation_unreview_parameters_spec.rb +29 -0
  29. data/spec/models/translations_unreview_parameters_spec.rb +35 -0
  30. data/spec/models/upload_summary_spec.rb +12 -0
  31. metadata +235 -235
  32. data/docs/CommentsListParameters.md +0 -25
  33. data/docs/RepliesListParameters.md +0 -23
  34. data/spec/models/comments_list_parameters_spec.rb +0 -53
  35. data/spec/models/replies_list_parameters_spec.rb +0 -47
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f228bf8ae41413d0bbb14c70ed64cd31485ed1e134d120cf74a346ae79aab4b7
4
- data.tar.gz: 901e918ea3a51ed87d8af44d906b25ef01bedd4fde41930e43211a4a8bb0eb39
3
+ metadata.gz: 04bf3ebdd9d603c87adf2947d530e382f37097aee543be5b2cb4dccd7db69534
4
+ data.tar.gz: 2dc353e4330710c12f66deab8bd9faf89561c5d3412ba5dd2fdd4d110691906d
5
5
  SHA512:
6
- metadata.gz: 91f57eb4cbaa4f82451bdc24f91f4adb4a2a5023e1a12d364efbcfea49caed9fc179b9677e8572a7f0a4b03e5b737908973a7e309338c02cb420fc2ca0965a46
7
- data.tar.gz: 4b666fc2ece5838b561582e83af78ebe70eec7f76c0e3f7b79f9188acd6bfe22f51ee4307bd84487baf7872389237bf248df0ca24a25cefbaf994cb13515823d
6
+ metadata.gz: 72b9f71936dc753d69b3dd654bbd780f81dee8d51dcf726c50b9759b08fc8bc6d41fb70b0c7a5931e94506cc304baa456cf405d39af80d4e29dccfb519637149
7
+ data.tar.gz: 6355285399a4b1257e7961bb3b3efdb4a5b184314855b89039ad3d49b855ff53a5b3dfe69d2011a9d8ec9d4dee1b59ac1e60191a98085eddb8376a7670445101
data/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.5.0](https://github.com/phrase/openapi/compare/ruby-v4.4.0...ruby-v4.5.0) (2025-05-16)
4
+
5
+
6
+ ### Features
7
+
8
+ * **API:** Add "verify_mentioned_translations" parameter to uploads ([#830](https://github.com/phrase/openapi/issues/830)) ([f2fdf60](https://github.com/phrase/openapi/commit/f2fdf60dd97c3908293cd457a765dafde603bd9b))
9
+ * **API:** Add processed & upload total translations on upload summary ([#824](https://github.com/phrase/openapi/issues/824)) ([081db68](https://github.com/phrase/openapi/commit/081db68d2ffcf5d66a81e07eec0a9572a1f9d633))
10
+ * **API:** Translations unreview & batch unreview ([#831](https://github.com/phrase/openapi/issues/831)) ([6a696db](https://github.com/phrase/openapi/commit/6a696db00d80d8acaf5887a08a7a97997566eb8f))
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * **API:** Remove request body from GET comments ([#817](https://github.com/phrase/openapi/issues/817)) ([2646001](https://github.com/phrase/openapi/commit/264600132e80ac03983e0ae86e99db3d6fb9080d))
16
+
3
17
  ## [4.4.0](https://github.com/phrase/openapi/compare/ruby-v4.3.0...ruby-v4.4.0) (2025-03-04)
4
18
 
5
19
 
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.4.0
10
+ - Package version: 4.5.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.4.0.gem
59
+ gem install ./phrase-4.5.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-4.4.0.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-4.5.0.gem` to install the development dependencies)
63
63
 
64
64
  ## Getting Started
65
65
 
@@ -365,6 +365,7 @@ Class | Method | HTTP request | Description
365
365
  *Phrase::TranslationsApi* | [**translation_include**](docs/TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
366
366
  *Phrase::TranslationsApi* | [**translation_review**](docs/TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
367
367
  *Phrase::TranslationsApi* | [**translation_show**](docs/TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
368
+ *Phrase::TranslationsApi* | [**translation_unreview**](docs/TranslationsApi.md#translation_unreview) | **PATCH** /projects/{project_id}/translations/{id}/unreview | Unreview a translation
368
369
  *Phrase::TranslationsApi* | [**translation_unverify**](docs/TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
369
370
  *Phrase::TranslationsApi* | [**translation_update**](docs/TranslationsApi.md#translation_update) | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
370
371
  *Phrase::TranslationsApi* | [**translation_verify**](docs/TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
@@ -375,6 +376,7 @@ Class | Method | HTTP request | Description
375
376
  *Phrase::TranslationsApi* | [**translations_list**](docs/TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
376
377
  *Phrase::TranslationsApi* | [**translations_review_collection**](docs/TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
377
378
  *Phrase::TranslationsApi* | [**translations_search**](docs/TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
379
+ *Phrase::TranslationsApi* | [**translations_unreview_collection**](docs/TranslationsApi.md#translations_unreview_collection) | **PATCH** /projects/{project_id}/translations/unreview | Unreview translations selected by query
378
380
  *Phrase::TranslationsApi* | [**translations_unverify_collection**](docs/TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
379
381
  *Phrase::TranslationsApi* | [**translations_verify_collection**](docs/TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
380
382
  *Phrase::UploadsApi* | [**upload_create**](docs/UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
@@ -424,7 +426,6 @@ Class | Method | HTTP request | Description
424
426
  - [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
425
427
  - [Phrase::CommentReaction](docs/CommentReaction.md)
426
428
  - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
427
- - [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
428
429
  - [Phrase::CurrentUser](docs/CurrentUser.md)
429
430
  - [Phrase::CustomMetadataDataType](docs/CustomMetadataDataType.md)
430
431
  - [Phrase::CustomMetadataPropertiesCreateParameters](docs/CustomMetadataPropertiesCreateParameters.md)
@@ -548,7 +549,6 @@ Class | Method | HTTP request | Description
548
549
  - [Phrase::ReleaseTrigger](docs/ReleaseTrigger.md)
549
550
  - [Phrase::ReleaseUpdateParameters](docs/ReleaseUpdateParameters.md)
550
551
  - [Phrase::ReleaseUpdateParameters1](docs/ReleaseUpdateParameters1.md)
551
- - [Phrase::RepliesListParameters](docs/RepliesListParameters.md)
552
552
  - [Phrase::RepoSync](docs/RepoSync.md)
553
553
  - [Phrase::RepoSyncEvent](docs/RepoSyncEvent.md)
554
554
  - [Phrase::Screenshot](docs/Screenshot.md)
@@ -591,6 +591,7 @@ Class | Method | HTTP request | Description
591
591
  - [Phrase::TranslationOrder](docs/TranslationOrder.md)
592
592
  - [Phrase::TranslationParent](docs/TranslationParent.md)
593
593
  - [Phrase::TranslationReviewParameters](docs/TranslationReviewParameters.md)
594
+ - [Phrase::TranslationUnreviewParameters](docs/TranslationUnreviewParameters.md)
594
595
  - [Phrase::TranslationUnverifyParameters](docs/TranslationUnverifyParameters.md)
595
596
  - [Phrase::TranslationUpdateParameters](docs/TranslationUpdateParameters.md)
596
597
  - [Phrase::TranslationVerifyParameters](docs/TranslationVerifyParameters.md)
@@ -600,6 +601,7 @@ Class | Method | HTTP request | Description
600
601
  - [Phrase::TranslationsIncludeParameters](docs/TranslationsIncludeParameters.md)
601
602
  - [Phrase::TranslationsReviewParameters](docs/TranslationsReviewParameters.md)
602
603
  - [Phrase::TranslationsSearchParameters](docs/TranslationsSearchParameters.md)
604
+ - [Phrase::TranslationsUnreviewParameters](docs/TranslationsUnreviewParameters.md)
603
605
  - [Phrase::TranslationsUnverifyParameters](docs/TranslationsUnverifyParameters.md)
604
606
  - [Phrase::TranslationsVerifyParameters](docs/TranslationsVerifyParameters.md)
605
607
  - [Phrase::Upload](docs/Upload.md)
data/docs/CommentRepliesApi.md CHANGED
@@ -15,7 +15,7 @@ Method | HTTP request | Description
15
15
 
16
16
  ## replies_list
17
17
 
18
- > Array<Comment> replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
18
+ > Array<Comment> replies_list(project_id, key_id, comment_id, opts)
19
19
 
20
20
  List replies
21
21
 
@@ -41,7 +41,6 @@ api_instance = Phrase::CommentRepliesApi.new
41
41
  project_id = 'project_id_example' # String | Project ID
42
42
  key_id = 'key_id_example' # String | Translation Key ID
43
43
  comment_id = 'comment_id_example' # String | Comment ID
44
- replies_list_parameters = Phrase::RepliesListParameters.new # RepliesListParameters |
45
44
  opts = {
46
45
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
47
46
  page: 1, # Integer | Page number
@@ -54,7 +53,7 @@ opts = {
54
53
 
55
54
  begin
56
55
  #List replies
57
- result = api_instance.replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
56
+ result = api_instance.replies_list(project_id, key_id, comment_id, opts)
58
57
  pp result
59
58
  rescue Phrase::ApiError => e
60
59
  puts "Exception when calling CommentRepliesApi->replies_list: #{e}"
@@ -69,7 +68,6 @@ Name | Type | Description | Notes
69
68
  **project_id** | **String**| Project ID |
70
69
  **key_id** | **String**| Translation Key ID |
71
70
  **comment_id** | **String**| Comment ID |
72
- **replies_list_parameters** | [**RepliesListParameters**](RepliesListParameters.md)| |
73
71
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
74
72
  **page** | **Integer**| Page number | [optional]
75
73
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
@@ -88,7 +86,7 @@ Response<([**Array&lt;Comment&gt;**](Comment.md))>
88
86
 
89
87
  ### HTTP request headers
90
88
 
91
- - **Content-Type**: application/json
89
+ - **Content-Type**: Not defined
92
90
  - **Accept**: application/json
93
91
 
94
92
 
data/docs/CommentsApi.md CHANGED
@@ -480,7 +480,7 @@ Response<([**Comment**](Comment.md))>
480
480
 
481
481
  ## comments_list
482
482
 
483
- > Array&lt;Comment&gt; comments_list(project_id, key_id, comments_list_parameters, opts)
483
+ > Array&lt;Comment&gt; comments_list(project_id, key_id, opts)
484
484
 
485
485
  List comments
486
486
 
@@ -505,7 +505,6 @@ end
505
505
  api_instance = Phrase::CommentsApi.new
506
506
  project_id = 'project_id_example' # String | Project ID
507
507
  key_id = 'key_id_example' # String | Translation Key ID
508
- comments_list_parameters = Phrase::CommentsListParameters.new # CommentsListParameters |
509
508
  opts = {
510
509
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
511
510
  page: 1, # Integer | Page number
@@ -519,7 +518,7 @@ opts = {
519
518
 
520
519
  begin
521
520
  #List comments
522
- result = api_instance.comments_list(project_id, key_id, comments_list_parameters, opts)
521
+ result = api_instance.comments_list(project_id, key_id, opts)
523
522
  pp result
524
523
  rescue Phrase::ApiError => e
525
524
  puts "Exception when calling CommentsApi->comments_list: #{e}"
@@ -533,7 +532,6 @@ Name | Type | Description | Notes
533
532
  ------------- | ------------- | ------------- | -------------
534
533
  **project_id** | **String**| Project ID |
535
534
  **key_id** | **String**| Translation Key ID |
536
- **comments_list_parameters** | [**CommentsListParameters**](CommentsListParameters.md)| |
537
535
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
538
536
  **page** | **Integer**| Page number | [optional]
539
537
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
@@ -553,6 +551,6 @@ Response<([**Array&lt;Comment&gt;**](Comment.md))>
553
551
 
554
552
  ### HTTP request headers
555
553
 
556
- - **Content-Type**: application/json
554
+ - **Content-Type**: Not defined
557
555
  - **Accept**: application/json
558
556
 
data/docs/KeyCreateParameters.md CHANGED
@@ -36,7 +36,7 @@ instance = Phrase::KeyCreateParameters.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@43a34f02,
39
+ screenshot: [B@905e189,
40
40
  remove_screenshot: null,
41
41
  unformatted: null,
42
42
  default_translation_content: Default translation content,
data/docs/KeyUpdateParameters.md CHANGED
@@ -34,7 +34,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
34
34
  data_type: number,
35
35
  tags: awesome-feature,needs-proofreading,
36
36
  max_characters_allowed: 140,
37
- screenshot: [B@1a445b5,
37
+ screenshot: [B@7b31281b,
38
38
  remove_screenshot: null,
39
39
  unformatted: null,
40
40
  xml_space_preserve: null,
data/docs/ProjectCreateParameters.md CHANGED
@@ -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@19ed779e,
40
+ project_image: [B@63c9017b,
41
41
  remove_project_image: null,
42
42
  account_id: abcd1234,
43
43
  point_of_contact: abcd1234,
data/docs/ProjectUpdateParameters.md CHANGED
@@ -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@2dfde704,
42
+ project_image: [B@4db7fe2c,
43
43
  remove_project_image: false,
44
44
  workflow: review,
45
45
  machine_translation_enabled: true,
data/docs/ScreenshotUpdateParameters.md CHANGED
@@ -17,7 +17,7 @@ require 'Phrase'
17
17
  instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
18
18
  name: A screenshot name,
19
19
  description: A screenshot description,
20
- filename: [B@31809f2b)
20
+ filename: [B@22ecee76)
21
21
  ```
22
22
 
23
23
 
data/docs/TranslationUnreviewParameters.md ADDED
@@ -0,0 +1,17 @@
1
+ # Phrase::TranslationUnreviewParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **branch** | **String** | specify the branch to use | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::TranslationUnreviewParameters.new(branch: my-feature-branch)
15
+ ```
16
+
17
+
data/docs/TranslationsApi.md CHANGED
@@ -9,6 +9,7 @@ Method | HTTP request | Description
9
9
  [**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
10
10
  [**translation_review**](TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
11
11
  [**translation_show**](TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
12
+ [**translation_unreview**](TranslationsApi.md#translation_unreview) | **PATCH** /projects/{project_id}/translations/{id}/unreview | Unreview a translation
12
13
  [**translation_unverify**](TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
13
14
  [**translation_update**](TranslationsApi.md#translation_update) | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
14
15
  [**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
@@ -19,6 +20,7 @@ Method | HTTP request | Description
19
20
  [**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
20
21
  [**translations_review_collection**](TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
21
22
  [**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
23
+ [**translations_unreview_collection**](TranslationsApi.md#translations_unreview_collection) | **PATCH** /projects/{project_id}/translations/unreview | Unreview translations selected by query
22
24
  [**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
23
25
  [**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
24
26
 
@@ -347,6 +349,71 @@ Response<([**TranslationDetails**](TranslationDetails.md))>
347
349
  - **Accept**: application/json
348
350
 
349
351
 
352
+ ## translation_unreview
353
+
354
+ > TranslationDetails translation_unreview(project_id, id, translation_unreview_parameters, opts)
355
+
356
+ Unreview a translation
357
+
358
+ Mark a reviewed translation as translated.
359
+
360
+ ### Example
361
+
362
+ ```ruby
363
+ # load the gem
364
+ require 'phrase'
365
+ # setup authorization
366
+ Phrase.configure do |config|
367
+ # Configure HTTP basic authorization: Basic
368
+ config.username = 'YOUR USERNAME'
369
+ config.password = 'YOUR PASSWORD'
370
+
371
+ # Configure API key authorization: Token
372
+ config.api_key['Authorization'] = 'YOUR API KEY'
373
+ config.api_key_prefix['Authorization'] = 'token'
374
+ end
375
+
376
+ api_instance = Phrase::TranslationsApi.new
377
+ project_id = 'project_id_example' # String | Project ID
378
+ id = 'id_example' # String | ID
379
+ translation_unreview_parameters = Phrase::TranslationUnreviewParameters.new # TranslationUnreviewParameters |
380
+ opts = {
381
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
382
+ }
383
+
384
+ begin
385
+ #Unreview a translation
386
+ result = api_instance.translation_unreview(project_id, id, translation_unreview_parameters, opts)
387
+ pp result
388
+ rescue Phrase::ApiError => e
389
+ puts "Exception when calling TranslationsApi->translation_unreview: #{e}"
390
+ end
391
+ ```
392
+
393
+ ### Parameters
394
+
395
+
396
+ Name | Type | Description | Notes
397
+ ------------- | ------------- | ------------- | -------------
398
+ **project_id** | **String**| Project ID |
399
+ **id** | **String**| ID |
400
+ **translation_unreview_parameters** | [**TranslationUnreviewParameters**](TranslationUnreviewParameters.md)| |
401
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
402
+
403
+ ### Return type
404
+
405
+ Response<([**TranslationDetails**](TranslationDetails.md))>
406
+
407
+ ### Authorization
408
+
409
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
410
+
411
+ ### HTTP request headers
412
+
413
+ - **Content-Type**: application/json
414
+ - **Accept**: application/json
415
+
416
+
350
417
  ## translation_unverify
351
418
 
352
419
  > TranslationDetails translation_unverify(project_id, id, translation_unverify_parameters, opts)
@@ -1025,6 +1092,69 @@ Response<([**Array&lt;Translation&gt;**](Translation.md))>
1025
1092
  - **Accept**: application/json
1026
1093
 
1027
1094
 
1095
+ ## translations_unreview_collection
1096
+
1097
+ > AffectedCount translations_unreview_collection(project_id, translations_unreview_parameters, opts)
1098
+
1099
+ Unreview translations selected by query
1100
+
1101
+ Unreview translations matching query.
1102
+
1103
+ ### Example
1104
+
1105
+ ```ruby
1106
+ # load the gem
1107
+ require 'phrase'
1108
+ # setup authorization
1109
+ Phrase.configure do |config|
1110
+ # Configure HTTP basic authorization: Basic
1111
+ config.username = 'YOUR USERNAME'
1112
+ config.password = 'YOUR PASSWORD'
1113
+
1114
+ # Configure API key authorization: Token
1115
+ config.api_key['Authorization'] = 'YOUR API KEY'
1116
+ config.api_key_prefix['Authorization'] = 'token'
1117
+ end
1118
+
1119
+ api_instance = Phrase::TranslationsApi.new
1120
+ project_id = 'project_id_example' # String | Project ID
1121
+ translations_unreview_parameters = Phrase::TranslationsUnreviewParameters.new # TranslationsUnreviewParameters |
1122
+ opts = {
1123
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
1124
+ }
1125
+
1126
+ begin
1127
+ #Unreview translations selected by query
1128
+ result = api_instance.translations_unreview_collection(project_id, translations_unreview_parameters, opts)
1129
+ pp result
1130
+ rescue Phrase::ApiError => e
1131
+ puts "Exception when calling TranslationsApi->translations_unreview_collection: #{e}"
1132
+ end
1133
+ ```
1134
+
1135
+ ### Parameters
1136
+
1137
+
1138
+ Name | Type | Description | Notes
1139
+ ------------- | ------------- | ------------- | -------------
1140
+ **project_id** | **String**| Project ID |
1141
+ **translations_unreview_parameters** | [**TranslationsUnreviewParameters**](TranslationsUnreviewParameters.md)| |
1142
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
1143
+
1144
+ ### Return type
1145
+
1146
+ Response<([**AffectedCount**](AffectedCount.md))>
1147
+
1148
+ ### Authorization
1149
+
1150
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
1151
+
1152
+ ### HTTP request headers
1153
+
1154
+ - **Content-Type**: application/json
1155
+ - **Accept**: application/json
1156
+
1157
+
1028
1158
  ## translations_unverify_collection
1029
1159
 
1030
1160
  > AffectedCount translations_unverify_collection(project_id, translations_unverify_parameters, opts)
data/docs/TranslationsUnreviewParameters.md ADDED
@@ -0,0 +1,19 @@
1
+ # Phrase::TranslationsUnreviewParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **branch** | **String** | specify the branch to use | [optional]
8
+ **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::TranslationsUnreviewParameters.new(branch: my-feature-branch,
16
+ q: PhraseApp*%reviewed:true%20tags:feature,center)
17
+ ```
18
+
19
+
data/docs/UploadSummary.md CHANGED
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
12
12
  **translations_updated** | **Integer** | | [optional]
13
13
  **tags_created** | **Integer** | | [optional]
14
14
  **translation_keys_ignored** | **Integer** | | [optional]
15
+ **processed_translations** | **Integer** | | [optional]
16
+ **upload_total_translations** | **Integer** | | [optional]
15
17
 
16
18
  ## Code Sample
17
19
 
@@ -25,7 +27,9 @@ instance = Phrase::UploadSummary.new(locales_created: null,
25
27
  translations_created: null,
26
28
  translations_updated: null,
27
29
  tags_created: null,
28
- translation_keys_ignored: null)
30
+ translation_keys_ignored: null,
31
+ processed_translations: null,
32
+ upload_total_translations: null)
29
33
  ```
30
34
 
31
35
 
data/docs/UploadsApi.md CHANGED
@@ -54,6 +54,7 @@ opts = {
54
54
  locale_mapping: { ... }, # Object | Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
55
55
  format_options: { ... }, # Object | Additional options available for specific formats. See our format guide for the [complete list](https://support.phrase.com/hc/en-us/articles/9652464547740-List-of-Supported-File-Types-Strings).
56
56
  autotranslate: true, # Boolean | If set, translations for the uploaded language will be fetched automatically.
57
+ verify_mentioned_translations: true, # Boolean | Indicates whether all translations mentioned in the upload should be verified.
57
58
  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.
58
59
  tag_only_affected_keys: true, # Boolean | Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
59
60
  translation_key_prefix: 'translation_key_prefix_example' # String | This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized.
@@ -91,6 +92,7 @@ Name | Type | Description | Notes
91
92
  **locale_mapping** | [**Object**](Object.md)| Mapping between locale names and translation columns. Required in some formats like CSV or XLSX. | [optional]
92
93
  **format_options** | [**Object**](Object.md)| Additional options available for specific formats. See our format guide for the [complete list](https://support.phrase.com/hc/en-us/articles/9652464547740-List-of-Supported-File-Types-Strings). | [optional]
93
94
  **autotranslate** | **Boolean**| If set, translations for the uploaded language will be fetched automatically. | [optional]
95
+ **verify_mentioned_translations** | **Boolean**| Indicates whether all translations mentioned in the upload should be verified. | [optional] [default to false]
94
96
  **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]
95
97
  **tag_only_affected_keys** | **Boolean**| Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is &#x60;false&#x60; | [optional] [default to false]
96
98
  **translation_key_prefix** | **String**| This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized. | [optional]
data/lib/phrase/api/comment_replies_api.rb CHANGED
@@ -12,7 +12,6 @@ module Phrase
12
12
  # @param project_id [String] Project ID
13
13
  # @param key_id [String] Translation Key ID
14
14
  # @param comment_id [String] Comment ID
15
- # @param replies_list_parameters [RepliesListParameters]
16
15
  # @param [Hash] opts the optional parameters
17
16
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
18
17
  # @option opts [Integer] :page Page number
@@ -22,8 +21,8 @@ module Phrase
22
21
  # @option opts [Array<String>] :filters Specify the filter for the comments
23
22
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
24
23
  # @return [Array<Comment>]
25
- def replies_list(project_id, key_id, comment_id, replies_list_parameters, opts = {})
26
- data, _status_code, _headers = replies_list_with_http_info(project_id, key_id, comment_id, replies_list_parameters, opts)
24
+ def replies_list(project_id, key_id, comment_id, opts = {})
25
+ data, _status_code, _headers = replies_list_with_http_info(project_id, key_id, comment_id, opts)
27
26
  data
28
27
  end
29
28
 
@@ -32,7 +31,6 @@ module Phrase
32
31
  # @param project_id [String] Project ID
33
32
  # @param key_id [String] Translation Key ID
34
33
  # @param comment_id [String] Comment ID
35
- # @param replies_list_parameters [RepliesListParameters]
36
34
  # @param [Hash] opts the optional parameters
37
35
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
38
36
  # @option opts [Integer] :page Page number
@@ -42,7 +40,7 @@ module Phrase
42
40
  # @option opts [Array<String>] :filters Specify the filter for the comments
43
41
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
44
42
  # @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
45
- def replies_list_with_http_info(project_id, key_id, comment_id, replies_list_parameters, opts = {})
43
+ def replies_list_with_http_info(project_id, key_id, comment_id, opts = {})
46
44
  if @api_client.config.debugging
47
45
  @api_client.config.logger.debug 'Calling API: CommentRepliesApi.replies_list ...'
48
46
  end
@@ -58,10 +56,6 @@ module Phrase
58
56
  if @api_client.config.client_side_validation && comment_id.nil?
59
57
  fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentRepliesApi.replies_list"
60
58
  end
61
- # verify the required parameter 'replies_list_parameters' is set
62
- if @api_client.config.client_side_validation && replies_list_parameters.nil?
63
- fail ArgumentError, "Missing the required parameter 'replies_list_parameters' when calling CommentRepliesApi.replies_list"
64
- end
65
59
  # resource path
66
60
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'comment_id' + '}', CGI.escape(comment_id.to_s))
67
61
 
@@ -78,15 +72,13 @@ module Phrase
78
72
  header_params = opts[:header_params] || {}
79
73
  # HTTP header 'Accept' (if needed)
80
74
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
81
- # HTTP header 'Content-Type'
82
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
83
75
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
84
76
 
85
77
  # form parameters
86
78
  form_params = opts[:form_params] || {}
87
79
 
88
80
  # http body (model)
89
- post_body = opts[:body] || @api_client.object_to_http_body(replies_list_parameters)
81
+ post_body = opts[:body]
90
82
 
91
83
  # return_type
92
84
  return_type = opts[:return_type] || 'Array<Comment>'
data/lib/phrase/api/comments_api.rb CHANGED
@@ -579,7 +579,6 @@ module Phrase
579
579
  # List all comments for a key.
580
580
  # @param project_id [String] Project ID
581
581
  # @param key_id [String] Translation Key ID
582
- # @param comments_list_parameters [CommentsListParameters]
583
582
  # @param [Hash] opts the optional parameters
584
583
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
585
584
  # @option opts [Integer] :page Page number
@@ -590,8 +589,8 @@ module Phrase
590
589
  # @option opts [Array<String>] :filters Specify the filter for the comments
591
590
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
592
591
  # @return [Array<Comment>]
593
- def comments_list(project_id, key_id, comments_list_parameters, opts = {})
594
- data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts)
592
+ def comments_list(project_id, key_id, opts = {})
593
+ data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, opts)
595
594
  data
596
595
  end
597
596
 
@@ -599,7 +598,6 @@ module Phrase
599
598
  # List all comments for a key.
600
599
  # @param project_id [String] Project ID
601
600
  # @param key_id [String] Translation Key ID
602
- # @param comments_list_parameters [CommentsListParameters]
603
601
  # @param [Hash] opts the optional parameters
604
602
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
605
603
  # @option opts [Integer] :page Page number
@@ -610,7 +608,7 @@ module Phrase
610
608
  # @option opts [Array<String>] :filters Specify the filter for the comments
611
609
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
612
610
  # @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
613
- def comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts = {})
611
+ def comments_list_with_http_info(project_id, key_id, opts = {})
614
612
  if @api_client.config.debugging
615
613
  @api_client.config.logger.debug 'Calling API: CommentsApi.comments_list ...'
616
614
  end
@@ -622,10 +620,6 @@ module Phrase
622
620
  if @api_client.config.client_side_validation && key_id.nil?
623
621
  fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comments_list"
624
622
  end
625
- # verify the required parameter 'comments_list_parameters' is set
626
- if @api_client.config.client_side_validation && comments_list_parameters.nil?
627
- fail ArgumentError, "Missing the required parameter 'comments_list_parameters' when calling CommentsApi.comments_list"
628
- end
629
623
  # resource path
630
624
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
631
625
 
@@ -643,15 +637,13 @@ module Phrase
643
637
  header_params = opts[:header_params] || {}
644
638
  # HTTP header 'Accept' (if needed)
645
639
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
646
- # HTTP header 'Content-Type'
647
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
648
640
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
649
641
 
650
642
  # form parameters
651
643
  form_params = opts[:form_params] || {}
652
644
 
653
645
  # http body (model)
654
- post_body = opts[:body] || @api_client.object_to_http_body(comments_list_parameters)
646
+ post_body = opts[:body]
655
647
 
656
648
  # return_type
657
649
  return_type = opts[:return_type] || 'Array<Comment>'