phrase 2.14.0 → 2.16.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a84d4b1908bfbb105768607982ae6df42c5d29769a83703e9cf4776022cb14dd
4
- data.tar.gz: eaef85f36598f65cd86d4cbdadba04d736023835dee31ce9d014c33420c94d7d
3
+ metadata.gz: cc5274b2e42f539a10f7260663c5cbfd5f5c6c3fca1265150c74d60ecc0ee6da
4
+ data.tar.gz: 46ef9968f4ffa0d0a5b6de4c7cbcba4331a5a1484c30fba03188f691bcc7369f
5
5
  SHA512:
6
- metadata.gz: 44cad7e58e9a1da63e70197af4b725ba8c287edf61eb3a7d7925caea72f5788c4f0eff38098411ca28279705700cef0ee17ecb600fc0ee4cdbe8b29c1f7b372b
7
- data.tar.gz: 800dbacc70321c8e8f3d5c93e48aa7df6f402cb110a0880575b0f77b323f17832a00778cd43c929c52b02ffcf35a89fb6c5d86a5e25ca8c90b35cdad7bef255e
6
+ metadata.gz: cacdd9077b60519f829f29fda5e7a91acac0eeb91e2e610fd3e823209725dc98ca129dbfbbe73b3a7d086409b597591c4dde4143d3a3e856f048b9c832d57f83
7
+ data.tar.gz: 5b89f88f5cb4b00b805216d26fb6de02bc350d451558f8bb05e05087a9aa27a65e21542fdbd6367d2604e044b5b48b771024f7e6a7d4ff0fe6159ec82f9117fc
data/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
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
+
11
+ ## [2.15.0](https://github.com/phrase/openapi/compare/ruby-v2.14.0...ruby-v2.15.0) (2023-08-28)
12
+
13
+
14
+ ### Features
15
+
16
+ * **API:** Document new query parameters ([#393](https://github.com/phrase/openapi/issues/393)) ([770515a](https://github.com/phrase/openapi/commit/770515a9628122955bb3919405babf9392684eb9))
17
+
3
18
  ## [2.14.0](https://github.com/phrase/openapi/compare/ruby-v2.13.0...ruby-v2.14.0) (2023-08-24)
4
19
 
5
20
 
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.14.0
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.14.0.gem
59
+ gem install ./phrase-2.16.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-2.14.0.gem` to install the development dependencies)
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
 
@@ -407,6 +407,7 @@ Class | Method | HTTP request | Description
407
407
  - [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
408
408
  - [Phrase::CommentReaction](docs/CommentReaction.md)
409
409
  - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
410
+ - [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
410
411
  - [Phrase::CurrentUser](docs/CurrentUser.md)
411
412
  - [Phrase::Distribution](docs/Distribution.md)
412
413
  - [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
@@ -515,6 +516,7 @@ Class | Method | HTTP request | Description
515
516
  - [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
516
517
  - [Phrase::ReleasePreview](docs/ReleasePreview.md)
517
518
  - [Phrase::ReleaseUpdateParameters](docs/ReleaseUpdateParameters.md)
519
+ - [Phrase::RepliesListParameters](docs/RepliesListParameters.md)
518
520
  - [Phrase::Screenshot](docs/Screenshot.md)
519
521
  - [Phrase::ScreenshotCreateParameters](docs/ScreenshotCreateParameters.md)
520
522
  - [Phrase::ScreenshotMarker](docs/ScreenshotMarker.md)
@@ -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, opts)
18
+ > Array<Comment> replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
19
19
 
20
20
  List replies
21
21
 
@@ -41,16 +41,19 @@ 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 |
44
45
  opts = {
45
46
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
46
47
  page: 1, # Integer | Page number
47
48
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
48
- branch: 'my-feature-branch' # String | specify the branch to use
49
+ branch: 'my-feature-branch', # String | specify the branch to use
50
+ query: 'Some comment content', # String | Search query for comment messages
51
+ filters: ['[\"read\",\"unread\"]'] # Array<String> | Specify the filter for the comments
49
52
  }
50
53
 
51
54
  begin
52
55
  #List replies
53
- result = api_instance.replies_list(project_id, key_id, comment_id, opts)
56
+ result = api_instance.replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
54
57
  pp result
55
58
  rescue Phrase::ApiError => e
56
59
  puts "Exception when calling CommentRepliesApi->replies_list: #{e}"
@@ -65,10 +68,13 @@ Name | Type | Description | Notes
65
68
  **project_id** | **String**| Project ID |
66
69
  **key_id** | **String**| Translation Key ID |
67
70
  **comment_id** | **String**| Comment ID |
71
+ **replies_list_parameters** | [**RepliesListParameters**](RepliesListParameters.md)| |
68
72
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
69
73
  **page** | **Integer**| Page number | [optional]
70
74
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
71
75
  **branch** | **String**| specify the branch to use | [optional]
76
+ **query** | **String**| Search query for comment messages | [optional]
77
+ **filters** | [**Array&lt;String&gt;**](String.md)| Specify the filter for the comments | [optional]
72
78
 
73
79
  ### Return type
74
80
 
@@ -80,7 +86,7 @@ Response<([**Array&lt;Comment&gt;**](Comment.md))>
80
86
 
81
87
  ### HTTP request headers
82
88
 
83
- - **Content-Type**: Not defined
89
+ - **Content-Type**: application/json
84
90
  - **Accept**: application/json
85
91
 
86
92
 
data/docs/CommentsApi.md CHANGED
@@ -484,7 +484,7 @@ Response<([**Comment**](Comment.md))>
484
484
 
485
485
  ## comments_list
486
486
 
487
- > Array&lt;Comment&gt; comments_list(project_id, key_id, opts)
487
+ > Array&lt;Comment&gt; comments_list(project_id, key_id, comments_list_parameters, opts)
488
488
 
489
489
  List comments
490
490
 
@@ -509,16 +509,20 @@ end
509
509
  api_instance = Phrase::CommentsApi.new
510
510
  project_id = 'project_id_example' # String | Project ID
511
511
  key_id = 'key_id_example' # String | Translation Key ID
512
+ comments_list_parameters = Phrase::CommentsListParameters.new # CommentsListParameters |
512
513
  opts = {
513
514
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
514
515
  page: 1, # Integer | Page number
515
516
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
516
- branch: 'my-feature-branch' # String | specify the branch to use
517
+ branch: 'my-feature-branch', # String | specify the branch to use
518
+ query: 'Some comment content', # String | Search query for comment messages
519
+ locale_ids: ['[\"someId\"]'], # Array<String> | Search comments by their assigned locales
520
+ filters: ['[\"read\",\"unread\"]'] # Array<String> | Specify the filter for the comments
517
521
  }
518
522
 
519
523
  begin
520
524
  #List comments
521
- result = api_instance.comments_list(project_id, key_id, opts)
525
+ result = api_instance.comments_list(project_id, key_id, comments_list_parameters, opts)
522
526
  pp result
523
527
  rescue Phrase::ApiError => e
524
528
  puts "Exception when calling CommentsApi->comments_list: #{e}"
@@ -532,10 +536,14 @@ Name | Type | Description | Notes
532
536
  ------------- | ------------- | ------------- | -------------
533
537
  **project_id** | **String**| Project ID |
534
538
  **key_id** | **String**| Translation Key ID |
539
+ **comments_list_parameters** | [**CommentsListParameters**](CommentsListParameters.md)| |
535
540
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
536
541
  **page** | **Integer**| Page number | [optional]
537
542
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
538
543
  **branch** | **String**| specify the branch to use | [optional]
544
+ **query** | **String**| Search query for comment messages | [optional]
545
+ **locale_ids** | [**Array&lt;String&gt;**](String.md)| Search comments by their assigned locales | [optional]
546
+ **filters** | [**Array&lt;String&gt;**](String.md)| Specify the filter for the comments | [optional]
539
547
 
540
548
  ### Return type
541
549
 
@@ -547,6 +555,6 @@ Response<([**Array&lt;Comment&gt;**](Comment.md))>
547
555
 
548
556
  ### HTTP request headers
549
557
 
550
- - **Content-Type**: Not defined
558
+ - **Content-Type**: application/json
551
559
  - **Accept**: application/json
552
560
 
@@ -0,0 +1,23 @@
1
+ # Phrase::CommentsListParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **branch** | **String** | Specify the branch to use | [optional]
8
+ **query** | **String** | Search query for comment messages | [optional]
9
+ **locale_ids** | **Array&lt;String&gt;** | Search comments by their assigned locales | [optional]
10
+ **filters** | **Array&lt;String&gt;** | Specify filters to find comments by | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'Phrase'
16
+
17
+ instance = Phrase::CommentsListParameters.new(branch: my-feature-branch,
18
+ query: Some comment content,
19
+ locale_ids: [&quot;someId&quot;,&quot;otherId&quot;],
20
+ filters: [&quot;read&quot;,&quot;unread&quot;])
21
+ ```
22
+
23
+
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 &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional]
276
276
  **if_none_match** | **String**| ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (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
 
@@ -0,0 +1,21 @@
1
+ # Phrase::RepliesListParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **branch** | **String** | Specify the branch to use | [optional]
8
+ **query** | **String** | Search query for comment messages | [optional]
9
+ **filters** | **Array&lt;String&gt;** | Specify filters to find comments by | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::RepliesListParameters.new(branch: my-feature-branch,
17
+ query: Some comment content,
18
+ filters: [&quot;read&quot;,&quot;unread&quot;])
19
+ ```
20
+
21
+
@@ -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).&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]
882
+ **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;li&gt;&lt;code&gt;reviewed_after:2013-02-21T00:00:00Z&lt;/code&gt; for fetching translations that were reviewed after the given timestamp&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [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 &#x60;false&#x60; | [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: {&quot;en&quot;: &quot;2&quot;},
40
41
  format_options: {&quot;foo&quot;: &quot;bar&quot;},
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 &#x60;false&#x60; | [optional] [default to false]
89
91
 
90
92
  ### Return type
91
93
 
@@ -12,14 +12,17 @@ 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]
15
16
  # @param [Hash] opts the optional parameters
16
17
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
17
18
  # @option opts [Integer] :page Page number
18
19
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
19
20
  # @option opts [String] :branch specify the branch to use
21
+ # @option opts [String] :query Search query for comment messages
22
+ # @option opts [Array<String>] :filters Specify the filter for the comments
20
23
  # @return [Array<Comment>]
21
- def replies_list(project_id, key_id, comment_id, opts = {})
22
- data, _status_code, _headers = replies_list_with_http_info(project_id, key_id, comment_id, opts)
24
+ def replies_list(project_id, key_id, comment_id, replies_list_parameters, opts = {})
25
+ data, _status_code, _headers = replies_list_with_http_info(project_id, key_id, comment_id, replies_list_parameters, opts)
23
26
  data
24
27
  end
25
28
 
@@ -28,13 +31,16 @@ module Phrase
28
31
  # @param project_id [String] Project ID
29
32
  # @param key_id [String] Translation Key ID
30
33
  # @param comment_id [String] Comment ID
34
+ # @param replies_list_parameters [RepliesListParameters]
31
35
  # @param [Hash] opts the optional parameters
32
36
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
33
37
  # @option opts [Integer] :page Page number
34
38
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
35
39
  # @option opts [String] :branch specify the branch to use
40
+ # @option opts [String] :query Search query for comment messages
41
+ # @option opts [Array<String>] :filters Specify the filter for the comments
36
42
  # @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
37
- def replies_list_with_http_info(project_id, key_id, comment_id, opts = {})
43
+ def replies_list_with_http_info(project_id, key_id, comment_id, replies_list_parameters, opts = {})
38
44
  if @api_client.config.debugging
39
45
  @api_client.config.logger.debug 'Calling API: CommentRepliesApi.replies_list ...'
40
46
  end
@@ -50,6 +56,10 @@ module Phrase
50
56
  if @api_client.config.client_side_validation && comment_id.nil?
51
57
  fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentRepliesApi.replies_list"
52
58
  end
59
+ # verify the required parameter 'replies_list_parameters' is set
60
+ if @api_client.config.client_side_validation && replies_list_parameters.nil?
61
+ fail ArgumentError, "Missing the required parameter 'replies_list_parameters' when calling CommentRepliesApi.replies_list"
62
+ end
53
63
  # resource path
54
64
  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))
55
65
 
@@ -58,18 +68,22 @@ module Phrase
58
68
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
59
69
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
60
70
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
71
+ query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
72
+ query_params[:'filters'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
61
73
 
62
74
  # header parameters
63
75
  header_params = opts[:header_params] || {}
64
76
  # HTTP header 'Accept' (if needed)
65
77
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
78
+ # HTTP header 'Content-Type'
79
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
66
80
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
67
81
 
68
82
  # form parameters
69
83
  form_params = opts[:form_params] || {}
70
84
 
71
85
  # http body (model)
72
- post_body = opts[:body]
86
+ post_body = opts[:body] || @api_client.object_to_http_body(replies_list_parameters)
73
87
 
74
88
  # return_type
75
89
  return_type = opts[:return_type] || 'Array<Comment>'
@@ -585,14 +585,18 @@ module Phrase
585
585
  # List all comments for a key.
586
586
  # @param project_id [String] Project ID
587
587
  # @param key_id [String] Translation Key ID
588
+ # @param comments_list_parameters [CommentsListParameters]
588
589
  # @param [Hash] opts the optional parameters
589
590
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
590
591
  # @option opts [Integer] :page Page number
591
592
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
592
593
  # @option opts [String] :branch specify the branch to use
594
+ # @option opts [String] :query Search query for comment messages
595
+ # @option opts [Array<String>] :locale_ids Search comments by their assigned locales
596
+ # @option opts [Array<String>] :filters Specify the filter for the comments
593
597
  # @return [Array<Comment>]
594
- def comments_list(project_id, key_id, opts = {})
595
- data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, opts)
598
+ def comments_list(project_id, key_id, comments_list_parameters, opts = {})
599
+ data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts)
596
600
  data
597
601
  end
598
602
 
@@ -600,13 +604,17 @@ module Phrase
600
604
  # List all comments for a key.
601
605
  # @param project_id [String] Project ID
602
606
  # @param key_id [String] Translation Key ID
607
+ # @param comments_list_parameters [CommentsListParameters]
603
608
  # @param [Hash] opts the optional parameters
604
609
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
605
610
  # @option opts [Integer] :page Page number
606
611
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
607
612
  # @option opts [String] :branch specify the branch to use
613
+ # @option opts [String] :query Search query for comment messages
614
+ # @option opts [Array<String>] :locale_ids Search comments by their assigned locales
615
+ # @option opts [Array<String>] :filters Specify the filter for the comments
608
616
  # @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
609
- def comments_list_with_http_info(project_id, key_id, opts = {})
617
+ def comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts = {})
610
618
  if @api_client.config.debugging
611
619
  @api_client.config.logger.debug 'Calling API: CommentsApi.comments_list ...'
612
620
  end
@@ -618,6 +626,10 @@ module Phrase
618
626
  if @api_client.config.client_side_validation && key_id.nil?
619
627
  fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comments_list"
620
628
  end
629
+ # verify the required parameter 'comments_list_parameters' is set
630
+ if @api_client.config.client_side_validation && comments_list_parameters.nil?
631
+ fail ArgumentError, "Missing the required parameter 'comments_list_parameters' when calling CommentsApi.comments_list"
632
+ end
621
633
  # resource path
622
634
  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))
623
635
 
@@ -626,18 +638,23 @@ module Phrase
626
638
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
627
639
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
628
640
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
641
+ query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
642
+ query_params[:'locale_ids'] = @api_client.build_collection_param(opts[:'locale_ids'], :multi) if !opts[:'locale_ids'].nil?
643
+ query_params[:'filters'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
629
644
 
630
645
  # header parameters
631
646
  header_params = opts[:header_params] || {}
632
647
  # HTTP header 'Accept' (if needed)
633
648
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
649
+ # HTTP header 'Content-Type'
650
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
634
651
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
635
652
 
636
653
  # form parameters
637
654
  form_params = opts[:form_params] || {}
638
655
 
639
656
  # http body (model)
640
- post_body = opts[:body]
657
+ post_body = opts[:body] || @api_client.object_to_http_body(comments_list_parameters)
641
658
 
642
659
  # return_type
643
660
  return_type = opts[:return_type] || 'Array<Comment>'
@@ -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 &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (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 &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (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).&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;.
979
+ # @option opts [String] :q 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;li&gt;&lt;code&gt;reviewed_after:2013-02-21T00:00:00Z&lt;/code&gt; for fetching translations that were reviewed after the given timestamp&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.
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).&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;.
998
+ # @option opts [String] :q 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;li&gt;&lt;code&gt;reviewed_after:2013-02-21T00:00:00Z&lt;/code&gt; for fetching translations that were reviewed after the given timestamp&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.
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 &#x60;false&#x60; (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 &#x60;false&#x60;
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]