phrase 3.6.0 → 3.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +4 -3
  4. data/docs/CommentCreateParameters.md +5 -3
  5. data/docs/CommentCreateParameters1.md +19 -0
  6. data/docs/CommentRepliesApi.md +6 -8
  7. data/docs/CommentsApi.md +2 -6
  8. data/docs/JobCommentCreateParameters.md +3 -1
  9. data/docs/JobCommentUpdateParameters.md +3 -1
  10. data/docs/JobCommentsApi.md +6 -6
  11. data/docs/JobLocalesApi.md +6 -6
  12. data/docs/KeyCreateParameters.md +3 -1
  13. data/docs/KeyUpdateParameters.md +1 -1
  14. data/docs/ProjectCreateParameters.md +1 -1
  15. data/docs/ProjectUpdateParameters.md +1 -1
  16. data/docs/ScreenshotUpdateParameters.md +1 -1
  17. data/docs/UploadsApi.md +2 -2
  18. data/lib/phrase/api/comment_replies_api.rb +12 -10
  19. data/lib/phrase/api/comments_api.rb +0 -6
  20. data/lib/phrase/api/job_comments_api.rb +6 -6
  21. data/lib/phrase/api/job_locales_api.rb +6 -6
  22. data/lib/phrase/api/uploads_api.rb +2 -2
  23. data/lib/phrase/models/comment_create_parameters.rb +25 -8
  24. data/lib/phrase/models/comment_create_parameters1.rb +212 -0
  25. data/lib/phrase/models/job_comment_create_parameters.rb +14 -4
  26. data/lib/phrase/models/job_comment_update_parameters.rb +14 -4
  27. data/lib/phrase/models/key_create_parameters.rb +11 -1
  28. data/lib/phrase/version.rb +1 -1
  29. data/lib/phrase.rb +1 -0
  30. data/spec/api/comment_replies_api_spec.rb +1 -2
  31. data/spec/api/comments_api_spec.rb +0 -2
  32. data/spec/api/job_comments_api_spec.rb +3 -3
  33. data/spec/api/job_locales_api_spec.rb +3 -3
  34. data/spec/models/comment_create_parameters1_spec.rb +35 -0
  35. data/spec/models/comment_create_parameters_spec.rb +7 -1
  36. data/spec/models/job_comment_create_parameters_spec.rb +6 -0
  37. data/spec/models/job_comment_update_parameters_spec.rb +6 -0
  38. data/spec/models/key_create_parameters_spec.rb +6 -0
  39. metadata +247 -243
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2cbdc81f70312c5895a659e9d0edc781474fb9b8e556aae9e731b071930ab13d
4
- data.tar.gz: 1feed72759454a8a723032f0af5f37cac81a1b3dbc7612f7c2598815f5745560
3
+ metadata.gz: 1bb3229e222a0064464b959c4a17aadaa56181799f685bcab3ebff3c35d43d48
4
+ data.tar.gz: 680687aa555b3edbd2b70f461c33610f26ef12cebc6b96b7f8cefa7bc60882d1
5
5
  SHA512:
6
- metadata.gz: 65537e4e14c006c2dc71d541f1100eae5e8a5f894f0a2c5be55fe10c1887f51cb91f46285c5085f032cd752941e0840d9c542bfa8a60d9ba51b86b529834fb83
7
- data.tar.gz: 1fdbd4990350fc4346907c9ceec7ee9f28ef688d89af5d1354949da610251d631412e3565027e9f7fb3da1ef16a6e26280993f26ac66b611db75344a1175c5ae
6
+ metadata.gz: 119905a86ab45fc4d2ac2174cd2a6baf0a84a3b14359cb190037b8b5dfc41281af53f847b80e28395ac21a1d5c39897830cf1dde316626804a9f37a5d0a70a43
7
+ data.tar.gz: 307f899c13fa45a9e3996f433b6f6526e4f16ba45551f202340c46d0240a0f565e7fe337ec8772588d2c55973617a77531205ac00ef3338bace47fa0fd0cd611
data/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # Changelog
2
2
 
3
+ ## [3.7.1](https://github.com/phrase/openapi/compare/ruby-v3.7.0...ruby-v3.7.1) (2024-12-09)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **API:** Add missing branch parameter to job comment endpoints #STRINGS-988 ([#724](https://github.com/phrase/openapi/issues/724)) ([64d399c](https://github.com/phrase/openapi/commit/64d399ced0980ac2a48366f91110047287a0c590))
9
+
10
+ ## [3.7.0](https://github.com/phrase/openapi/compare/ruby-v3.6.0...ruby-v3.7.0) (2024-12-03)
11
+
12
+
13
+ ### Features
14
+
15
+ * **API:** Add Pagination header to POST search endpoints [[#457](https://github.com/phrase/openapi/issues/457)] ([#706](https://github.com/phrase/openapi/issues/706)) ([9a79fa3](https://github.com/phrase/openapi/commit/9a79fa31bb3b9d58272fa2f4e82d72d0d44a93a0))
16
+ * **API:** autotranslate param in key creation [STRINGS-786] ([#713](https://github.com/phrase/openapi/issues/713)) ([581d0ff](https://github.com/phrase/openapi/commit/581d0ff5f1d06757e5ddd9603b78fc8d435d68ee))
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * **API:** Comment creation schema fix #STRINGS-866 ([#718](https://github.com/phrase/openapi/issues/718)) ([e201d13](https://github.com/phrase/openapi/commit/e201d1360c89698dd8d3642cc28f89dd0e50a1fb))
22
+
3
23
  ## [3.6.0](https://github.com/phrase/openapi/compare/ruby-v3.5.0...ruby-v3.6.0) (2024-10-02)
4
24
 
5
25
 
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: 3.6.0
10
+ - Package version: 3.7.1
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-3.6.0.gem
59
+ gem install ./phrase-3.7.1.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-3.6.0.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-3.7.1.gem` to install the development dependencies)
63
63
 
64
64
  ## Getting Started
65
65
 
@@ -436,6 +436,7 @@ Class | Method | HTTP request | Description
436
436
  - [Phrase::BranchUpdateParameters](docs/BranchUpdateParameters.md)
437
437
  - [Phrase::Comment](docs/Comment.md)
438
438
  - [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
439
+ - [Phrase::CommentCreateParameters1](docs/CommentCreateParameters1.md)
439
440
  - [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
440
441
  - [Phrase::CommentReaction](docs/CommentReaction.md)
441
442
  - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
data/docs/CommentCreateParameters.md CHANGED
@@ -4,16 +4,18 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | Comment message |
7
8
  **branch** | **String** | specify the branch to use | [optional]
8
- **message** | **String** | Comment message | [optional]
9
+ **locale_ids** | **Array<String>** | specify the locales for the comment | [optional]
9
10
 
10
11
  ## Code Sample
11
12
 
12
13
  ```ruby
13
14
  require 'Phrase'
14
15
 
15
- instance = Phrase::CommentCreateParameters.new(branch: my-feature-branch,
16
- message: Some message...)
16
+ instance = Phrase::CommentCreateParameters.new(message: Some message...,
17
+ branch: my-feature-branch,
18
+ locale_ids: ["someId","someOtherId"])
17
19
  ```
18
20
 
19
21
 
data/docs/CommentCreateParameters1.md ADDED
@@ -0,0 +1,19 @@
1
+ # Phrase::CommentCreateParameters1
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | Reply message body |
8
+ **branch** | **String** | Specify the branch to use | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::CommentCreateParameters1.new(message: Some message...,
16
+ branch: my-feature-branch)
17
+ ```
18
+
19
+
data/docs/CommentRepliesApi.md CHANGED
@@ -94,7 +94,7 @@ Response<([**Array&lt;Comment&gt;**](Comment.md))>
94
94
 
95
95
  ## reply_create
96
96
 
97
- > Comment reply_create(project_id, key_id, comment_id, opts)
97
+ > Comment reply_create(project_id, key_id, comment_id, comment_create_parameters1, opts)
98
98
 
99
99
  Create a reply
100
100
 
@@ -120,15 +120,14 @@ api_instance = Phrase::CommentRepliesApi.new
120
120
  project_id = 'project_id_example' # String | Project ID
121
121
  key_id = 'key_id_example' # String | Translation Key ID
122
122
  comment_id = 'comment_id_example' # String | Comment ID
123
+ comment_create_parameters1 = Phrase::CommentCreateParameters1.new({message: 'Some message...'}) # CommentCreateParameters1 |
123
124
  opts = {
124
- x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
125
- branch: 'my-feature-branch', # String | specify the branch to use
126
- message: 'some message...' # String | specify the message for the comment
125
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
127
126
  }
128
127
 
129
128
  begin
130
129
  #Create a reply
131
- result = api_instance.reply_create(project_id, key_id, comment_id, opts)
130
+ result = api_instance.reply_create(project_id, key_id, comment_id, comment_create_parameters1, opts)
132
131
  pp result
133
132
  rescue Phrase::ApiError => e
134
133
  puts "Exception when calling CommentRepliesApi->reply_create: #{e}"
@@ -143,9 +142,8 @@ Name | Type | Description | Notes
143
142
  **project_id** | **String**| Project ID |
144
143
  **key_id** | **String**| Translation Key ID |
145
144
  **comment_id** | **String**| Comment ID |
145
+ **comment_create_parameters1** | [**CommentCreateParameters1**](CommentCreateParameters1.md)| |
146
146
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
147
- **branch** | **String**| specify the branch to use | [optional]
148
- **message** | **String**| specify the message for the comment | [optional]
149
147
 
150
148
  ### Return type
151
149
 
@@ -157,7 +155,7 @@ Response<([**Comment**](Comment.md))>
157
155
 
158
156
  ### HTTP request headers
159
157
 
160
- - **Content-Type**: Not defined
158
+ - **Content-Type**: application/json
161
159
  - **Accept**: application/json
162
160
 
163
161
 
data/docs/CommentsApi.md CHANGED
@@ -42,11 +42,9 @@ end
42
42
  api_instance = Phrase::CommentsApi.new
43
43
  project_id = 'project_id_example' # String | Project ID
44
44
  key_id = 'key_id_example' # String | Translation Key ID
45
- comment_create_parameters = Phrase::CommentCreateParameters.new # CommentCreateParameters |
45
+ comment_create_parameters = Phrase::CommentCreateParameters.new({message: 'Some message...'}) # CommentCreateParameters |
46
46
  opts = {
47
- x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
48
- message: 'some message...', # String | specify the message for the comment
49
- locale_ids: ['inner_example'] # Array<String> | specify the locales for the comment
47
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
50
48
  }
51
49
 
52
50
  begin
@@ -67,8 +65,6 @@ Name | Type | Description | Notes
67
65
  **key_id** | **String**| Translation Key ID |
68
66
  **comment_create_parameters** | [**CommentCreateParameters**](CommentCreateParameters.md)| |
69
67
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
70
- **message** | **String**| specify the message for the comment | [optional]
71
- **locale_ids** | [**Array&lt;String&gt;**](String.md)| specify the locales for the comment | [optional]
72
68
 
73
69
  ### Return type
74
70
 
data/docs/JobCommentCreateParameters.md CHANGED
@@ -5,13 +5,15 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **message** | **String** | Job comment message | [optional]
8
+ **branch** | **String** | Branch name for the job | [optional]
8
9
 
9
10
  ## Code Sample
10
11
 
11
12
  ```ruby
12
13
  require 'Phrase'
13
14
 
14
- instance = Phrase::JobCommentCreateParameters.new(message: Some message...)
15
+ instance = Phrase::JobCommentCreateParameters.new(message: Some message...,
16
+ branch: my-feature-branch)
15
17
  ```
16
18
 
17
19
 
data/docs/JobCommentUpdateParameters.md CHANGED
@@ -5,13 +5,15 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **message** | **String** | Comment message | [optional]
8
+ **branch** | **String** | Branch name for the job | [optional]
8
9
 
9
10
  ## Code Sample
10
11
 
11
12
  ```ruby
12
13
  require 'Phrase'
13
14
 
14
- instance = Phrase::JobCommentUpdateParameters.new(message: Some message...)
15
+ instance = Phrase::JobCommentUpdateParameters.new(message: Some message...,
16
+ branch: my-feature-branch)
15
17
  ```
16
18
 
17
19
 
data/docs/JobCommentsApi.md CHANGED
@@ -107,7 +107,7 @@ job_id = 'job_id_example' # String | Job ID
107
107
  id = 'id_example' # String | ID
108
108
  opts = {
109
109
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
110
- branch: 'my-feature-branch' # String | specify the branch to use
110
+ branch: 'my-feature-branch' # String | Branch to use
111
111
  }
112
112
 
113
113
  begin
@@ -127,7 +127,7 @@ Name | Type | Description | Notes
127
127
  **job_id** | **String**| Job ID |
128
128
  **id** | **String**| ID |
129
129
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
130
- **branch** | **String**| specify the branch to use | [optional]
130
+ **branch** | **String**| Branch to use | [optional]
131
131
 
132
132
  ### Return type
133
133
 
@@ -173,7 +173,7 @@ job_id = 'job_id_example' # String | Job ID
173
173
  id = 'id_example' # String | ID
174
174
  opts = {
175
175
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
176
- branch: 'my-feature-branch' # String | specify the branch to use
176
+ branch: 'my-feature-branch' # String | Branch to use
177
177
  }
178
178
 
179
179
  begin
@@ -194,7 +194,7 @@ Name | Type | Description | Notes
194
194
  **job_id** | **String**| Job ID |
195
195
  **id** | **String**| ID |
196
196
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
197
- **branch** | **String**| specify the branch to use | [optional]
197
+ **branch** | **String**| Branch to use | [optional]
198
198
 
199
199
  ### Return type
200
200
 
@@ -306,7 +306,7 @@ project_id = 'project_id_example' # String | Project ID
306
306
  job_id = 'job_id_example' # String | Job ID
307
307
  opts = {
308
308
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
309
- branch: 'my-feature-branch', # String | specify the branch to use
309
+ branch: 'my-feature-branch', # String | Branch to use
310
310
  order: 'desc' # String | Order direction. Can be one of: asc, desc.
311
311
  }
312
312
 
@@ -327,7 +327,7 @@ Name | Type | Description | Notes
327
327
  **project_id** | **String**| Project ID |
328
328
  **job_id** | **String**| Job ID |
329
329
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
330
- **branch** | **String**| specify the branch to use | [optional]
330
+ **branch** | **String**| Branch to use | [optional]
331
331
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
332
332
 
333
333
  ### Return type
data/docs/JobLocalesApi.md CHANGED
@@ -179,7 +179,7 @@ job_id = 'job_id_example' # String | Job ID
179
179
  id = 'id_example' # String | ID
180
180
  opts = {
181
181
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
182
- branch: 'my-feature-branch' # String | specify the branch to use
182
+ branch: 'my-feature-branch' # String | Branch to use
183
183
  }
184
184
 
185
185
  begin
@@ -199,7 +199,7 @@ Name | Type | Description | Notes
199
199
  **job_id** | **String**| Job ID |
200
200
  **id** | **String**| ID |
201
201
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
202
- **branch** | **String**| specify the branch to use | [optional]
202
+ **branch** | **String**| Branch to use | [optional]
203
203
 
204
204
  ### Return type
205
205
 
@@ -312,7 +312,7 @@ job_id = 'job_id_example' # String | Job ID
312
312
  id = 'id_example' # String | ID
313
313
  opts = {
314
314
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
315
- branch: 'my-feature-branch' # String | specify the branch to use
315
+ branch: 'my-feature-branch' # String | Branch to use
316
316
  }
317
317
 
318
318
  begin
@@ -333,7 +333,7 @@ Name | Type | Description | Notes
333
333
  **job_id** | **String**| Job ID |
334
334
  **id** | **String**| ID |
335
335
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
336
- **branch** | **String**| specify the branch to use | [optional]
336
+ **branch** | **String**| Branch to use | [optional]
337
337
 
338
338
  ### Return type
339
339
 
@@ -512,7 +512,7 @@ opts = {
512
512
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
513
513
  page: 1, # Integer | Page number
514
514
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
515
- branch: 'my-feature-branch' # String | specify the branch to use
515
+ branch: 'my-feature-branch' # String | Branch to use
516
516
  }
517
517
 
518
518
  begin
@@ -534,7 +534,7 @@ Name | Type | Description | Notes
534
534
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
535
535
  **page** | **Integer**| Page number | [optional]
536
536
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
537
- **branch** | **String**| specify the branch to use | [optional]
537
+ **branch** | **String**| Branch to use | [optional]
538
538
 
539
539
  ### Return type
540
540
 
data/docs/KeyCreateParameters.md CHANGED
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
16
16
  **remove_screenshot** | **Boolean** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
17
17
  **unformatted** | **Boolean** | Indicates whether the key should be exported as \&quot;unformatted\&quot;. Supported by Android XML and other formats. | [optional]
18
18
  **default_translation_content** | **String** | Creates a translation in the default locale with the specified content | [optional]
19
+ **autotranslate** | **Boolean** | Indicates whether the key should be autotranslated to other locales based on the copy provided in &#x60;default_translation_content&#x60;. | [optional]
19
20
  **xml_space_preserve** | **Boolean** | Indicates whether the key should be exported with \&quot;xml:space&#x3D;preserve\&quot;. Supported by several XML-based formats. | [optional]
20
21
  **original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
21
22
  **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
@@ -35,10 +36,11 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
35
36
  data_type: number,
36
37
  tags: awesome-feature,needs-proofreading,
37
38
  max_characters_allowed: 140,
38
- screenshot: [B@210d1b45,
39
+ screenshot: [B@11f8bff1,
39
40
  remove_screenshot: null,
40
41
  unformatted: null,
41
42
  default_translation_content: Default translation content,
43
+ autotranslate: null,
42
44
  xml_space_preserve: null,
43
45
  original_file: null,
44
46
  localized_format_string: null,
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@29862f60,
37
+ screenshot: [B@3fb2306,
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@776609b,
40
+ project_image: [B@3fa27158,
41
41
  remove_project_image: null,
42
42
  account_id: abcd1234,
43
43
  point_of_contact: abcd1234,
data/docs/ProjectUpdateParameters.md CHANGED
@@ -38,7 +38,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
38
38
  main_format: yml,
39
39
  media: Python,
40
40
  shares_translation_memory: true,
41
- project_image: [B@58da1b27,
41
+ project_image: [B@4b2b2757,
42
42
  remove_project_image: false,
43
43
  workflow: review,
44
44
  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@154bc3cf)
20
+ filename: [B@3d7c21b7)
21
21
  ```
22
22
 
23
23
 
data/docs/UploadsApi.md CHANGED
@@ -52,7 +52,7 @@ opts = {
52
52
  skip_unverification: true, # Boolean | Indicates whether the upload should unverify updated translations.
53
53
  file_encoding: 'file_encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
54
54
  locale_mapping: { ... }, # Object | Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
55
- format_options: { ... }, # Object | Additional options available for specific formats. See our format guide for complete list.
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
57
  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
58
  tag_only_affected_keys: true, # Boolean | Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
@@ -89,7 +89,7 @@ Name | Type | Description | Notes
89
89
  **skip_unverification** | **Boolean**| Indicates whether the upload should unverify updated translations. | [optional]
90
90
  **file_encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \\\&quot;UTF-8\\\&quot;, \\\&quot;UTF-16\\\&quot; and \\\&quot;ISO-8859-1\\\&quot;. | [optional]
91
91
  **locale_mapping** | [**Object**](Object.md)| Mapping between locale names and translation columns. Required in some formats like CSV or XLSX. | [optional]
92
- **format_options** | [**Object**](Object.md)| Additional options available for specific formats. See our format guide for complete list. | [optional]
92
+ **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
93
  **autotranslate** | **Boolean**| If set, translations for the uploaded language will be fetched automatically. | [optional]
94
94
  **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
95
  **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]
data/lib/phrase/api/comment_replies_api.rb CHANGED
@@ -116,13 +116,12 @@ module Phrase
116
116
  # @param project_id [String] Project ID
117
117
  # @param key_id [String] Translation Key ID
118
118
  # @param comment_id [String] Comment ID
119
+ # @param comment_create_parameters1 [CommentCreateParameters1]
119
120
  # @param [Hash] opts the optional parameters
120
121
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
121
- # @option opts [String] :branch specify the branch to use
122
- # @option opts [String] :message specify the message for the comment
123
122
  # @return [Comment]
124
- def reply_create(project_id, key_id, comment_id, opts = {})
125
- data, _status_code, _headers = reply_create_with_http_info(project_id, key_id, comment_id, opts)
123
+ def reply_create(project_id, key_id, comment_id, comment_create_parameters1, opts = {})
124
+ data, _status_code, _headers = reply_create_with_http_info(project_id, key_id, comment_id, comment_create_parameters1, opts)
126
125
  data
127
126
  end
128
127
 
@@ -131,12 +130,11 @@ module Phrase
131
130
  # @param project_id [String] Project ID
132
131
  # @param key_id [String] Translation Key ID
133
132
  # @param comment_id [String] Comment ID
133
+ # @param comment_create_parameters1 [CommentCreateParameters1]
134
134
  # @param [Hash] opts the optional parameters
135
135
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
136
- # @option opts [String] :branch specify the branch to use
137
- # @option opts [String] :message specify the message for the comment
138
136
  # @return [Array<(Response<(Comment)>, Integer, Hash)>] Response<(Comment)> data, response status code and response headers
139
- def reply_create_with_http_info(project_id, key_id, comment_id, opts = {})
137
+ def reply_create_with_http_info(project_id, key_id, comment_id, comment_create_parameters1, opts = {})
140
138
  if @api_client.config.debugging
141
139
  @api_client.config.logger.debug 'Calling API: CommentRepliesApi.reply_create ...'
142
140
  end
@@ -152,25 +150,29 @@ module Phrase
152
150
  if @api_client.config.client_side_validation && comment_id.nil?
153
151
  fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentRepliesApi.reply_create"
154
152
  end
153
+ # verify the required parameter 'comment_create_parameters1' is set
154
+ if @api_client.config.client_side_validation && comment_create_parameters1.nil?
155
+ fail ArgumentError, "Missing the required parameter 'comment_create_parameters1' when calling CommentRepliesApi.reply_create"
156
+ end
155
157
  # resource path
156
158
  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))
157
159
 
158
160
  # query parameters
159
161
  query_params = opts[:query_params] || {}
160
- query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
161
- query_params[:'message'] = opts[:'message'] if !opts[:'message'].nil?
162
162
 
163
163
  # header parameters
164
164
  header_params = opts[:header_params] || {}
165
165
  # HTTP header 'Accept' (if needed)
166
166
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
167
+ # HTTP header 'Content-Type'
168
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
167
169
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
168
170
 
169
171
  # form parameters
170
172
  form_params = opts[:form_params] || {}
171
173
 
172
174
  # http body (model)
173
- post_body = opts[:body]
175
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_create_parameters1)
174
176
 
175
177
  # return_type
176
178
  return_type = opts[:return_type] || 'Comment'
data/lib/phrase/api/comments_api.rb CHANGED
@@ -14,8 +14,6 @@ module Phrase
14
14
  # @param comment_create_parameters [CommentCreateParameters]
15
15
  # @param [Hash] opts the optional parameters
16
16
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
17
- # @option opts [String] :message specify the message for the comment
18
- # @option opts [Array<String>] :locale_ids specify the locales for the comment
19
17
  # @return [Comment]
20
18
  def comment_create(project_id, key_id, comment_create_parameters, opts = {})
21
19
  data, _status_code, _headers = comment_create_with_http_info(project_id, key_id, comment_create_parameters, opts)
@@ -29,8 +27,6 @@ module Phrase
29
27
  # @param comment_create_parameters [CommentCreateParameters]
30
28
  # @param [Hash] opts the optional parameters
31
29
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
32
- # @option opts [String] :message specify the message for the comment
33
- # @option opts [Array<String>] :locale_ids specify the locales for the comment
34
30
  # @return [Array<(Response<(Comment)>, Integer, Hash)>] Response<(Comment)> data, response status code and response headers
35
31
  def comment_create_with_http_info(project_id, key_id, comment_create_parameters, opts = {})
36
32
  if @api_client.config.debugging
@@ -53,8 +49,6 @@ module Phrase
53
49
 
54
50
  # query parameters
55
51
  query_params = opts[:query_params] || {}
56
- query_params[:'message'] = opts[:'message'] if !opts[:'message'].nil?
57
- query_params[:'locale_ids'] = @api_client.build_collection_param(opts[:'locale_ids'], :multi) if !opts[:'locale_ids'].nil?
58
52
 
59
53
  # header parameters
60
54
  header_params = opts[:header_params] || {}
data/lib/phrase/api/job_comments_api.rb CHANGED
@@ -94,7 +94,7 @@ module Phrase
94
94
  # @param id [String] ID
95
95
  # @param [Hash] opts the optional parameters
96
96
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
97
- # @option opts [String] :branch specify the branch to use
97
+ # @option opts [String] :branch Branch to use
98
98
  # @return [nil]
99
99
  def job_comment_delete(project_id, job_id, id, opts = {})
100
100
  data, _status_code, _headers = job_comment_delete_with_http_info(project_id, job_id, id, opts)
@@ -108,7 +108,7 @@ module Phrase
108
108
  # @param id [String] ID
109
109
  # @param [Hash] opts the optional parameters
110
110
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
111
- # @option opts [String] :branch specify the branch to use
111
+ # @option opts [String] :branch Branch to use
112
112
  # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
113
113
  def job_comment_delete_with_http_info(project_id, job_id, id, opts = {})
114
114
  if @api_client.config.debugging
@@ -173,7 +173,7 @@ module Phrase
173
173
  # @param id [String] ID
174
174
  # @param [Hash] opts the optional parameters
175
175
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
176
- # @option opts [String] :branch specify the branch to use
176
+ # @option opts [String] :branch Branch to use
177
177
  # @return [JobComment]
178
178
  def job_comment_show(project_id, job_id, id, opts = {})
179
179
  data, _status_code, _headers = job_comment_show_with_http_info(project_id, job_id, id, opts)
@@ -187,7 +187,7 @@ module Phrase
187
187
  # @param id [String] ID
188
188
  # @param [Hash] opts the optional parameters
189
189
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
190
- # @option opts [String] :branch specify the branch to use
190
+ # @option opts [String] :branch Branch to use
191
191
  # @return [Array<(Response<(JobComment)>, Integer, Hash)>] Response<(JobComment)> data, response status code and response headers
192
192
  def job_comment_show_with_http_info(project_id, job_id, id, opts = {})
193
193
  if @api_client.config.debugging
@@ -339,7 +339,7 @@ module Phrase
339
339
  # @param job_id [String] Job ID
340
340
  # @param [Hash] opts the optional parameters
341
341
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
342
- # @option opts [String] :branch specify the branch to use
342
+ # @option opts [String] :branch Branch to use
343
343
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
344
344
  # @return [Array<JobComment>]
345
345
  def job_comments_list(project_id, job_id, opts = {})
@@ -353,7 +353,7 @@ module Phrase
353
353
  # @param job_id [String] Job ID
354
354
  # @param [Hash] opts the optional parameters
355
355
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
356
- # @option opts [String] :branch specify the branch to use
356
+ # @option opts [String] :branch Branch to use
357
357
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
358
358
  # @return [Array<(Response<(Array<JobComment>)>, Integer, Hash)>] Response<(Array<JobComment>)> data, response status code and response headers
359
359
  def job_comments_list_with_http_info(project_id, job_id, opts = {})
data/lib/phrase/api/job_locales_api.rb CHANGED
@@ -186,7 +186,7 @@ module Phrase
186
186
  # @param id [String] ID
187
187
  # @param [Hash] opts the optional parameters
188
188
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
189
- # @option opts [String] :branch specify the branch to use
189
+ # @option opts [String] :branch Branch to use
190
190
  # @return [nil]
191
191
  def job_locale_delete(project_id, job_id, id, opts = {})
192
192
  data, _status_code, _headers = job_locale_delete_with_http_info(project_id, job_id, id, opts)
@@ -200,7 +200,7 @@ module Phrase
200
200
  # @param id [String] ID
201
201
  # @param [Hash] opts the optional parameters
202
202
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
203
- # @option opts [String] :branch specify the branch to use
203
+ # @option opts [String] :branch Branch to use
204
204
  # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
205
205
  def job_locale_delete_with_http_info(project_id, job_id, id, opts = {})
206
206
  if @api_client.config.debugging
@@ -351,7 +351,7 @@ module Phrase
351
351
  # @param id [String] ID
352
352
  # @param [Hash] opts the optional parameters
353
353
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
354
- # @option opts [String] :branch specify the branch to use
354
+ # @option opts [String] :branch Branch to use
355
355
  # @return [JobLocale]
356
356
  def job_locale_show(project_id, job_id, id, opts = {})
357
357
  data, _status_code, _headers = job_locale_show_with_http_info(project_id, job_id, id, opts)
@@ -365,7 +365,7 @@ module Phrase
365
365
  # @param id [String] ID
366
366
  # @param [Hash] opts the optional parameters
367
367
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
368
- # @option opts [String] :branch specify the branch to use
368
+ # @option opts [String] :branch Branch to use
369
369
  # @return [Array<(Response<(JobLocale)>, Integer, Hash)>] Response<(JobLocale)> data, response status code and response headers
370
370
  def job_locale_show_with_http_info(project_id, job_id, id, opts = {})
371
371
  if @api_client.config.debugging
@@ -599,7 +599,7 @@ module Phrase
599
599
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
600
600
  # @option opts [Integer] :page Page number
601
601
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
602
- # @option opts [String] :branch specify the branch to use
602
+ # @option opts [String] :branch Branch to use
603
603
  # @return [Array<JobLocale>]
604
604
  def job_locales_list(project_id, job_id, opts = {})
605
605
  data, _status_code, _headers = job_locales_list_with_http_info(project_id, job_id, opts)
@@ -614,7 +614,7 @@ module Phrase
614
614
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
615
615
  # @option opts [Integer] :page Page number
616
616
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
617
- # @option opts [String] :branch specify the branch to use
617
+ # @option opts [String] :branch Branch to use
618
618
  # @return [Array<(Response<(Array<JobLocale>)>, Integer, Hash)>] Response<(Array<JobLocale>)> data, response status code and response headers
619
619
  def job_locales_list_with_http_info(project_id, job_id, opts = {})
620
620
  if @api_client.config.debugging
data/lib/phrase/api/uploads_api.rb CHANGED
@@ -26,7 +26,7 @@ module Phrase
26
26
  # @option opts [Boolean] :skip_unverification Indicates whether the upload should unverify updated translations.
27
27
  # @option opts [String] :file_encoding Enforces a specific encoding on the file contents. Valid options are \\\&quot;UTF-8\\\&quot;, \\\&quot;UTF-16\\\&quot; and \\\&quot;ISO-8859-1\\\&quot;.
28
28
  # @option opts [Object] :locale_mapping Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
29
- # @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
29
+ # @option opts [Object] :format_options 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).
30
30
  # @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
31
31
  # @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.
32
32
  # @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)
@@ -56,7 +56,7 @@ module Phrase
56
56
  # @option opts [Boolean] :skip_unverification Indicates whether the upload should unverify updated translations.
57
57
  # @option opts [String] :file_encoding Enforces a specific encoding on the file contents. Valid options are \\\&quot;UTF-8\\\&quot;, \\\&quot;UTF-16\\\&quot; and \\\&quot;ISO-8859-1\\\&quot;.
58
58
  # @option opts [Object] :locale_mapping Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
59
- # @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
59
+ # @option opts [Object] :format_options 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).
60
60
  # @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
61
61
  # @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.
62
62
  # @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;