phrase 2.13.0 → 2.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +11 -3
- data/docs/Comment.md +5 -1
- data/docs/CommentReactionsApi.md +3 -1
- data/docs/CommentRepliesApi.md +433 -0
- data/docs/CommentsApi.md +17 -5
- data/docs/CommentsListParameters.md +23 -0
- data/docs/RepliesListParameters.md +21 -0
- data/lib/phrase/api/comment_reactions_api.rb +3 -0
- data/lib/phrase/api/comment_replies_api.rb +537 -0
- data/lib/phrase/api/comments_api.rb +27 -4
- data/lib/phrase/models/comment.rb +24 -4
- data/lib/phrase/models/comments_list_parameters.rb +229 -0
- data/lib/phrase/models/replies_list_parameters.rb +217 -0
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +3 -0
- data/spec/api/comment_reactions_api_spec.rb +1 -0
- data/spec/api/comment_replies_api_spec.rb +129 -0
- data/spec/api/comments_api_spec.rb +6 -0
- data/spec/models/comment_spec.rb +12 -0
- data/spec/models/comments_list_parameters_spec.rb +47 -0
- data/spec/models/replies_list_parameters_spec.rb +41 -0
- metadata +14 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a56234942a6166c1299cd75286a0ec37a654a98bfc998f806c8635b5cca69ef0
|
4
|
+
data.tar.gz: 3b8a5a7f7a6e782bce174f65697f6eaddbad169e912001a545ef2f3db119b632
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7537a76db6d34e63d666874a35ba8963823b0935af89555a957e02242bdd8e9ab175aff193018b8082339abbda7e71a5e60d58895310129e4409664167f7a5d4
|
7
|
+
data.tar.gz: 44f4dcae88b39e894ed424bd2e8816a2fe8ce0cd114e138b4a9653585f9af121535f7809aa918ad590e27642fe90d3c695762706348c65f9c6cbe81a541af55e
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,19 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [2.15.0](https://github.com/phrase/openapi/compare/ruby-v2.14.0...ruby-v2.15.0) (2023-08-28)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* **API:** Document new query parameters ([#393](https://github.com/phrase/openapi/issues/393)) ([770515a](https://github.com/phrase/openapi/commit/770515a9628122955bb3919405babf9392684eb9))
|
9
|
+
|
10
|
+
## [2.14.0](https://github.com/phrase/openapi/compare/ruby-v2.13.0...ruby-v2.14.0) (2023-08-24)
|
11
|
+
|
12
|
+
|
13
|
+
### Features
|
14
|
+
|
15
|
+
* **API:** Introduce comment replies endpoints ([#383](https://github.com/phrase/openapi/issues/383)) ([71351ac](https://github.com/phrase/openapi/commit/71351ac285f4f49976092e176c77b09f3485eb65))
|
16
|
+
|
3
17
|
## [2.13.0](https://github.com/phrase/openapi/compare/ruby-v2.12.0...ruby-v2.13.0) (2023-08-22)
|
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: 2.
|
10
|
+
- Package version: 2.15.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
|
13
13
|
|
@@ -56,10 +56,10 @@ gem build phrase.gemspec
|
|
56
56
|
Then install the gem locally:
|
57
57
|
|
58
58
|
```shell
|
59
|
-
gem install ./phrase-2.
|
59
|
+
gem install ./phrase-2.15.0.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.
|
62
|
+
(for development, run `gem install --dev ./phrase-2.15.0.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -156,6 +156,12 @@ Class | Method | HTTP request | Description
|
|
156
156
|
*Phrase::CommentReactionsApi* | [**reaction_delete**](docs/CommentReactionsApi.md#reaction_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Delete a reaction
|
157
157
|
*Phrase::CommentReactionsApi* | [**reaction_show**](docs/CommentReactionsApi.md#reaction_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Get a single reaction
|
158
158
|
*Phrase::CommentReactionsApi* | [**reactions_list**](docs/CommentReactionsApi.md#reactions_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions | List reactions
|
159
|
+
*Phrase::CommentRepliesApi* | [**replies_list**](docs/CommentRepliesApi.md#replies_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | List replies
|
160
|
+
*Phrase::CommentRepliesApi* | [**reply_create**](docs/CommentRepliesApi.md#reply_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | Create a reply
|
161
|
+
*Phrase::CommentRepliesApi* | [**reply_delete**](docs/CommentRepliesApi.md#reply_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Delete a reply
|
162
|
+
*Phrase::CommentRepliesApi* | [**reply_mark_as_read**](docs/CommentRepliesApi.md#reply_mark_as_read) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read | Mark a reply as read
|
163
|
+
*Phrase::CommentRepliesApi* | [**reply_mark_as_unread**](docs/CommentRepliesApi.md#reply_mark_as_unread) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread | Mark a reply as unread
|
164
|
+
*Phrase::CommentRepliesApi* | [**reply_show**](docs/CommentRepliesApi.md#reply_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Get a single reply
|
159
165
|
*Phrase::CommentsApi* | [**comment_create**](docs/CommentsApi.md#comment_create) | **POST** /projects/{project_id}/keys/{key_id}/comments | Create a comment
|
160
166
|
*Phrase::CommentsApi* | [**comment_delete**](docs/CommentsApi.md#comment_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{id} | Delete a comment
|
161
167
|
*Phrase::CommentsApi* | [**comment_mark_check**](docs/CommentsApi.md#comment_mark_check) | **GET** /projects/{project_id}/keys/{key_id}/comments/{id}/read | Check if comment is read
|
@@ -401,6 +407,7 @@ Class | Method | HTTP request | Description
|
|
401
407
|
- [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
|
402
408
|
- [Phrase::CommentReaction](docs/CommentReaction.md)
|
403
409
|
- [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
|
410
|
+
- [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
|
404
411
|
- [Phrase::CurrentUser](docs/CurrentUser.md)
|
405
412
|
- [Phrase::Distribution](docs/Distribution.md)
|
406
413
|
- [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
|
@@ -509,6 +516,7 @@ Class | Method | HTTP request | Description
|
|
509
516
|
- [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
|
510
517
|
- [Phrase::ReleasePreview](docs/ReleasePreview.md)
|
511
518
|
- [Phrase::ReleaseUpdateParameters](docs/ReleaseUpdateParameters.md)
|
519
|
+
- [Phrase::RepliesListParameters](docs/RepliesListParameters.md)
|
512
520
|
- [Phrase::Screenshot](docs/Screenshot.md)
|
513
521
|
- [Phrase::ScreenshotCreateParameters](docs/ScreenshotCreateParameters.md)
|
514
522
|
- [Phrase::ScreenshotMarker](docs/ScreenshotMarker.md)
|
data/docs/Comment.md
CHANGED
@@ -6,10 +6,12 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**id** | **String** | | [optional]
|
8
8
|
**message** | **String** | | [optional]
|
9
|
+
**has_replies** | **Boolean** | | [optional]
|
9
10
|
**user** | [**UserPreview**](UserPreview.md) | | [optional]
|
10
11
|
**created_at** | **DateTime** | | [optional]
|
11
12
|
**updated_at** | **DateTime** | | [optional]
|
12
13
|
**mentioned_users** | [**Array<UserPreview>**](UserPreview.md) | | [optional]
|
14
|
+
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
13
15
|
|
14
16
|
## Code Sample
|
15
17
|
|
@@ -18,10 +20,12 @@ require 'Phrase'
|
|
18
20
|
|
19
21
|
instance = Phrase::Comment.new(id: null,
|
20
22
|
message: null,
|
23
|
+
has_replies: null,
|
21
24
|
user: null,
|
22
25
|
created_at: null,
|
23
26
|
updated_at: null,
|
24
|
-
mentioned_users: null
|
27
|
+
mentioned_users: null,
|
28
|
+
locales: null)
|
25
29
|
```
|
26
30
|
|
27
31
|
|
data/docs/CommentReactionsApi.md
CHANGED
@@ -41,7 +41,8 @@ key_id = 'key_id_example' # String | Translation Key ID
|
|
41
41
|
comment_id = 'comment_id_example' # String | Comment ID
|
42
42
|
opts = {
|
43
43
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
44
|
-
branch: 'my-feature-branch' # String | specify the branch to use
|
44
|
+
branch: 'my-feature-branch', # String | specify the branch to use
|
45
|
+
emoji: '👍' # String | specify the emoji for the reaction
|
45
46
|
}
|
46
47
|
|
47
48
|
begin
|
@@ -63,6 +64,7 @@ Name | Type | Description | Notes
|
|
63
64
|
**comment_id** | **String**| Comment ID |
|
64
65
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
65
66
|
**branch** | **String**| specify the branch to use | [optional]
|
67
|
+
**emoji** | **String**| specify the emoji for the reaction | [optional]
|
66
68
|
|
67
69
|
### Return type
|
68
70
|
|
@@ -0,0 +1,433 @@
|
|
1
|
+
# Phrase::CommentRepliesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**replies_list**](CommentRepliesApi.md#replies_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | List replies
|
8
|
+
[**reply_create**](CommentRepliesApi.md#reply_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | Create a reply
|
9
|
+
[**reply_delete**](CommentRepliesApi.md#reply_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Delete a reply
|
10
|
+
[**reply_mark_as_read**](CommentRepliesApi.md#reply_mark_as_read) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read | Mark a reply as read
|
11
|
+
[**reply_mark_as_unread**](CommentRepliesApi.md#reply_mark_as_unread) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread | Mark a reply as unread
|
12
|
+
[**reply_show**](CommentRepliesApi.md#reply_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Get a single reply
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
## replies_list
|
17
|
+
|
18
|
+
> Array<Comment> replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
|
19
|
+
|
20
|
+
List replies
|
21
|
+
|
22
|
+
List all replies for a comment.
|
23
|
+
|
24
|
+
### Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'phrase'
|
29
|
+
# setup authorization
|
30
|
+
Phrase.configure do |config|
|
31
|
+
# Configure HTTP basic authorization: Basic
|
32
|
+
config.username = 'YOUR USERNAME'
|
33
|
+
config.password = 'YOUR PASSWORD'
|
34
|
+
|
35
|
+
# Configure API key authorization: Token
|
36
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
37
|
+
config.api_key_prefix['Authorization'] = 'token'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_instance = Phrase::CommentRepliesApi.new
|
41
|
+
project_id = 'project_id_example' # String | Project ID
|
42
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
43
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
44
|
+
replies_list_parameters = Phrase::RepliesListParameters.new # RepliesListParameters |
|
45
|
+
opts = {
|
46
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
47
|
+
page: 1, # Integer | Page number
|
48
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
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
|
52
|
+
}
|
53
|
+
|
54
|
+
begin
|
55
|
+
#List replies
|
56
|
+
result = api_instance.replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
|
57
|
+
pp result
|
58
|
+
rescue Phrase::ApiError => e
|
59
|
+
puts "Exception when calling CommentRepliesApi->replies_list: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
|
66
|
+
Name | Type | Description | Notes
|
67
|
+
------------- | ------------- | ------------- | -------------
|
68
|
+
**project_id** | **String**| Project ID |
|
69
|
+
**key_id** | **String**| Translation Key ID |
|
70
|
+
**comment_id** | **String**| Comment ID |
|
71
|
+
**replies_list_parameters** | [**RepliesListParameters**](RepliesListParameters.md)| |
|
72
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
73
|
+
**page** | **Integer**| Page number | [optional]
|
74
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
75
|
+
**branch** | **String**| specify the branch to use | [optional]
|
76
|
+
**query** | **String**| Search query for comment messages | [optional]
|
77
|
+
**filters** | [**Array<String>**](String.md)| Specify the filter for the comments | [optional]
|
78
|
+
|
79
|
+
### Return type
|
80
|
+
|
81
|
+
Response<([**Array<Comment>**](Comment.md))>
|
82
|
+
|
83
|
+
### Authorization
|
84
|
+
|
85
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
86
|
+
|
87
|
+
### HTTP request headers
|
88
|
+
|
89
|
+
- **Content-Type**: application/json
|
90
|
+
- **Accept**: application/json
|
91
|
+
|
92
|
+
|
93
|
+
## reply_create
|
94
|
+
|
95
|
+
> Comment reply_create(project_id, key_id, comment_id, opts)
|
96
|
+
|
97
|
+
Create a reply
|
98
|
+
|
99
|
+
Create a new reply for a comment.
|
100
|
+
|
101
|
+
### Example
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
# load the gem
|
105
|
+
require 'phrase'
|
106
|
+
# setup authorization
|
107
|
+
Phrase.configure do |config|
|
108
|
+
# Configure HTTP basic authorization: Basic
|
109
|
+
config.username = 'YOUR USERNAME'
|
110
|
+
config.password = 'YOUR PASSWORD'
|
111
|
+
|
112
|
+
# Configure API key authorization: Token
|
113
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
114
|
+
config.api_key_prefix['Authorization'] = 'token'
|
115
|
+
end
|
116
|
+
|
117
|
+
api_instance = Phrase::CommentRepliesApi.new
|
118
|
+
project_id = 'project_id_example' # String | Project ID
|
119
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
120
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
121
|
+
opts = {
|
122
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
123
|
+
branch: 'my-feature-branch', # String | specify the branch to use
|
124
|
+
message: 'some message...' # String | specify the message for the comment
|
125
|
+
}
|
126
|
+
|
127
|
+
begin
|
128
|
+
#Create a reply
|
129
|
+
result = api_instance.reply_create(project_id, key_id, comment_id, opts)
|
130
|
+
pp result
|
131
|
+
rescue Phrase::ApiError => e
|
132
|
+
puts "Exception when calling CommentRepliesApi->reply_create: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
|
139
|
+
Name | Type | Description | Notes
|
140
|
+
------------- | ------------- | ------------- | -------------
|
141
|
+
**project_id** | **String**| Project ID |
|
142
|
+
**key_id** | **String**| Translation Key ID |
|
143
|
+
**comment_id** | **String**| Comment ID |
|
144
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
145
|
+
**branch** | **String**| specify the branch to use | [optional]
|
146
|
+
**message** | **String**| specify the message for the comment | [optional]
|
147
|
+
|
148
|
+
### Return type
|
149
|
+
|
150
|
+
Response<([**Comment**](Comment.md))>
|
151
|
+
|
152
|
+
### Authorization
|
153
|
+
|
154
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
155
|
+
|
156
|
+
### HTTP request headers
|
157
|
+
|
158
|
+
- **Content-Type**: Not defined
|
159
|
+
- **Accept**: application/json
|
160
|
+
|
161
|
+
|
162
|
+
## reply_delete
|
163
|
+
|
164
|
+
> reply_delete(project_id, key_id, comment_id, id, opts)
|
165
|
+
|
166
|
+
Delete a reply
|
167
|
+
|
168
|
+
Delete an existing reply.
|
169
|
+
|
170
|
+
### Example
|
171
|
+
|
172
|
+
```ruby
|
173
|
+
# load the gem
|
174
|
+
require 'phrase'
|
175
|
+
# setup authorization
|
176
|
+
Phrase.configure do |config|
|
177
|
+
# Configure HTTP basic authorization: Basic
|
178
|
+
config.username = 'YOUR USERNAME'
|
179
|
+
config.password = 'YOUR PASSWORD'
|
180
|
+
|
181
|
+
# Configure API key authorization: Token
|
182
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
183
|
+
config.api_key_prefix['Authorization'] = 'token'
|
184
|
+
end
|
185
|
+
|
186
|
+
api_instance = Phrase::CommentRepliesApi.new
|
187
|
+
project_id = 'project_id_example' # String | Project ID
|
188
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
189
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
190
|
+
id = 'id_example' # String | ID
|
191
|
+
opts = {
|
192
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
193
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
194
|
+
}
|
195
|
+
|
196
|
+
begin
|
197
|
+
#Delete a reply
|
198
|
+
api_instance.reply_delete(project_id, key_id, comment_id, id, opts)
|
199
|
+
rescue Phrase::ApiError => e
|
200
|
+
puts "Exception when calling CommentRepliesApi->reply_delete: #{e}"
|
201
|
+
end
|
202
|
+
```
|
203
|
+
|
204
|
+
### Parameters
|
205
|
+
|
206
|
+
|
207
|
+
Name | Type | Description | Notes
|
208
|
+
------------- | ------------- | ------------- | -------------
|
209
|
+
**project_id** | **String**| Project ID |
|
210
|
+
**key_id** | **String**| Translation Key ID |
|
211
|
+
**comment_id** | **String**| Comment ID |
|
212
|
+
**id** | **String**| ID |
|
213
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
214
|
+
**branch** | **String**| specify the branch to use | [optional]
|
215
|
+
|
216
|
+
### Return type
|
217
|
+
|
218
|
+
Response<(nil (empty response body))>
|
219
|
+
|
220
|
+
### Authorization
|
221
|
+
|
222
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
223
|
+
|
224
|
+
### HTTP request headers
|
225
|
+
|
226
|
+
- **Content-Type**: Not defined
|
227
|
+
- **Accept**: Not defined
|
228
|
+
|
229
|
+
|
230
|
+
## reply_mark_as_read
|
231
|
+
|
232
|
+
> reply_mark_as_read(project_id, key_id, comment_id, id, opts)
|
233
|
+
|
234
|
+
Mark a reply as read
|
235
|
+
|
236
|
+
Mark a reply as read.
|
237
|
+
|
238
|
+
### Example
|
239
|
+
|
240
|
+
```ruby
|
241
|
+
# load the gem
|
242
|
+
require 'phrase'
|
243
|
+
# setup authorization
|
244
|
+
Phrase.configure do |config|
|
245
|
+
# Configure HTTP basic authorization: Basic
|
246
|
+
config.username = 'YOUR USERNAME'
|
247
|
+
config.password = 'YOUR PASSWORD'
|
248
|
+
|
249
|
+
# Configure API key authorization: Token
|
250
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
251
|
+
config.api_key_prefix['Authorization'] = 'token'
|
252
|
+
end
|
253
|
+
|
254
|
+
api_instance = Phrase::CommentRepliesApi.new
|
255
|
+
project_id = 'project_id_example' # String | Project ID
|
256
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
257
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
258
|
+
id = 'id_example' # String | ID
|
259
|
+
opts = {
|
260
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
261
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
262
|
+
}
|
263
|
+
|
264
|
+
begin
|
265
|
+
#Mark a reply as read
|
266
|
+
api_instance.reply_mark_as_read(project_id, key_id, comment_id, id, opts)
|
267
|
+
rescue Phrase::ApiError => e
|
268
|
+
puts "Exception when calling CommentRepliesApi->reply_mark_as_read: #{e}"
|
269
|
+
end
|
270
|
+
```
|
271
|
+
|
272
|
+
### Parameters
|
273
|
+
|
274
|
+
|
275
|
+
Name | Type | Description | Notes
|
276
|
+
------------- | ------------- | ------------- | -------------
|
277
|
+
**project_id** | **String**| Project ID |
|
278
|
+
**key_id** | **String**| Translation Key ID |
|
279
|
+
**comment_id** | **String**| Comment ID |
|
280
|
+
**id** | **String**| ID |
|
281
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
282
|
+
**branch** | **String**| specify the branch to use | [optional]
|
283
|
+
|
284
|
+
### Return type
|
285
|
+
|
286
|
+
Response<(nil (empty response body))>
|
287
|
+
|
288
|
+
### Authorization
|
289
|
+
|
290
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
291
|
+
|
292
|
+
### HTTP request headers
|
293
|
+
|
294
|
+
- **Content-Type**: Not defined
|
295
|
+
- **Accept**: Not defined
|
296
|
+
|
297
|
+
|
298
|
+
## reply_mark_as_unread
|
299
|
+
|
300
|
+
> reply_mark_as_unread(project_id, key_id, comment_id, id, opts)
|
301
|
+
|
302
|
+
Mark a reply as unread
|
303
|
+
|
304
|
+
Mark a reply as unread.
|
305
|
+
|
306
|
+
### Example
|
307
|
+
|
308
|
+
```ruby
|
309
|
+
# load the gem
|
310
|
+
require 'phrase'
|
311
|
+
# setup authorization
|
312
|
+
Phrase.configure do |config|
|
313
|
+
# Configure HTTP basic authorization: Basic
|
314
|
+
config.username = 'YOUR USERNAME'
|
315
|
+
config.password = 'YOUR PASSWORD'
|
316
|
+
|
317
|
+
# Configure API key authorization: Token
|
318
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
319
|
+
config.api_key_prefix['Authorization'] = 'token'
|
320
|
+
end
|
321
|
+
|
322
|
+
api_instance = Phrase::CommentRepliesApi.new
|
323
|
+
project_id = 'project_id_example' # String | Project ID
|
324
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
325
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
326
|
+
id = 'id_example' # String | ID
|
327
|
+
opts = {
|
328
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
329
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
330
|
+
}
|
331
|
+
|
332
|
+
begin
|
333
|
+
#Mark a reply as unread
|
334
|
+
api_instance.reply_mark_as_unread(project_id, key_id, comment_id, id, opts)
|
335
|
+
rescue Phrase::ApiError => e
|
336
|
+
puts "Exception when calling CommentRepliesApi->reply_mark_as_unread: #{e}"
|
337
|
+
end
|
338
|
+
```
|
339
|
+
|
340
|
+
### Parameters
|
341
|
+
|
342
|
+
|
343
|
+
Name | Type | Description | Notes
|
344
|
+
------------- | ------------- | ------------- | -------------
|
345
|
+
**project_id** | **String**| Project ID |
|
346
|
+
**key_id** | **String**| Translation Key ID |
|
347
|
+
**comment_id** | **String**| Comment ID |
|
348
|
+
**id** | **String**| ID |
|
349
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
350
|
+
**branch** | **String**| specify the branch to use | [optional]
|
351
|
+
|
352
|
+
### Return type
|
353
|
+
|
354
|
+
Response<(nil (empty response body))>
|
355
|
+
|
356
|
+
### Authorization
|
357
|
+
|
358
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
359
|
+
|
360
|
+
### HTTP request headers
|
361
|
+
|
362
|
+
- **Content-Type**: Not defined
|
363
|
+
- **Accept**: Not defined
|
364
|
+
|
365
|
+
|
366
|
+
## reply_show
|
367
|
+
|
368
|
+
> Comment reply_show(project_id, key_id, comment_id, id, opts)
|
369
|
+
|
370
|
+
Get a single reply
|
371
|
+
|
372
|
+
Get details on a single reply.
|
373
|
+
|
374
|
+
### Example
|
375
|
+
|
376
|
+
```ruby
|
377
|
+
# load the gem
|
378
|
+
require 'phrase'
|
379
|
+
# setup authorization
|
380
|
+
Phrase.configure do |config|
|
381
|
+
# Configure HTTP basic authorization: Basic
|
382
|
+
config.username = 'YOUR USERNAME'
|
383
|
+
config.password = 'YOUR PASSWORD'
|
384
|
+
|
385
|
+
# Configure API key authorization: Token
|
386
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
387
|
+
config.api_key_prefix['Authorization'] = 'token'
|
388
|
+
end
|
389
|
+
|
390
|
+
api_instance = Phrase::CommentRepliesApi.new
|
391
|
+
project_id = 'project_id_example' # String | Project ID
|
392
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
393
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
394
|
+
id = 'id_example' # String | ID
|
395
|
+
opts = {
|
396
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
397
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
398
|
+
}
|
399
|
+
|
400
|
+
begin
|
401
|
+
#Get a single reply
|
402
|
+
result = api_instance.reply_show(project_id, key_id, comment_id, id, opts)
|
403
|
+
pp result
|
404
|
+
rescue Phrase::ApiError => e
|
405
|
+
puts "Exception when calling CommentRepliesApi->reply_show: #{e}"
|
406
|
+
end
|
407
|
+
```
|
408
|
+
|
409
|
+
### Parameters
|
410
|
+
|
411
|
+
|
412
|
+
Name | Type | Description | Notes
|
413
|
+
------------- | ------------- | ------------- | -------------
|
414
|
+
**project_id** | **String**| Project ID |
|
415
|
+
**key_id** | **String**| Translation Key ID |
|
416
|
+
**comment_id** | **String**| Comment ID |
|
417
|
+
**id** | **String**| ID |
|
418
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
419
|
+
**branch** | **String**| specify the branch to use | [optional]
|
420
|
+
|
421
|
+
### Return type
|
422
|
+
|
423
|
+
Response<([**Comment**](Comment.md))>
|
424
|
+
|
425
|
+
### Authorization
|
426
|
+
|
427
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
428
|
+
|
429
|
+
### HTTP request headers
|
430
|
+
|
431
|
+
- **Content-Type**: Not defined
|
432
|
+
- **Accept**: application/json
|
433
|
+
|
data/docs/CommentsApi.md
CHANGED
@@ -44,7 +44,9 @@ project_id = 'project_id_example' # String | Project ID
|
|
44
44
|
key_id = 'key_id_example' # String | Translation Key ID
|
45
45
|
comment_create_parameters = Phrase::CommentCreateParameters.new # CommentCreateParameters |
|
46
46
|
opts = {
|
47
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
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: ['someId'] # Array<String> | specify the locales for the comment
|
48
50
|
}
|
49
51
|
|
50
52
|
begin
|
@@ -65,6 +67,8 @@ Name | Type | Description | Notes
|
|
65
67
|
**key_id** | **String**| Translation Key ID |
|
66
68
|
**comment_create_parameters** | [**CommentCreateParameters**](CommentCreateParameters.md)| |
|
67
69
|
**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<String>**](String.md)| specify the locales for the comment | [optional]
|
68
72
|
|
69
73
|
### Return type
|
70
74
|
|
@@ -480,7 +484,7 @@ Response<([**Comment**](Comment.md))>
|
|
480
484
|
|
481
485
|
## comments_list
|
482
486
|
|
483
|
-
> Array<Comment> comments_list(project_id, key_id, opts)
|
487
|
+
> Array<Comment> comments_list(project_id, key_id, comments_list_parameters, opts)
|
484
488
|
|
485
489
|
List comments
|
486
490
|
|
@@ -505,16 +509,20 @@ end
|
|
505
509
|
api_instance = Phrase::CommentsApi.new
|
506
510
|
project_id = 'project_id_example' # String | Project ID
|
507
511
|
key_id = 'key_id_example' # String | Translation Key ID
|
512
|
+
comments_list_parameters = Phrase::CommentsListParameters.new # CommentsListParameters |
|
508
513
|
opts = {
|
509
514
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
510
515
|
page: 1, # Integer | Page number
|
511
516
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
512
|
-
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
|
513
521
|
}
|
514
522
|
|
515
523
|
begin
|
516
524
|
#List comments
|
517
|
-
result = api_instance.comments_list(project_id, key_id, opts)
|
525
|
+
result = api_instance.comments_list(project_id, key_id, comments_list_parameters, opts)
|
518
526
|
pp result
|
519
527
|
rescue Phrase::ApiError => e
|
520
528
|
puts "Exception when calling CommentsApi->comments_list: #{e}"
|
@@ -528,10 +536,14 @@ Name | Type | Description | Notes
|
|
528
536
|
------------- | ------------- | ------------- | -------------
|
529
537
|
**project_id** | **String**| Project ID |
|
530
538
|
**key_id** | **String**| Translation Key ID |
|
539
|
+
**comments_list_parameters** | [**CommentsListParameters**](CommentsListParameters.md)| |
|
531
540
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
532
541
|
**page** | **Integer**| Page number | [optional]
|
533
542
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
534
543
|
**branch** | **String**| specify the branch to use | [optional]
|
544
|
+
**query** | **String**| Search query for comment messages | [optional]
|
545
|
+
**locale_ids** | [**Array<String>**](String.md)| Search comments by their assigned locales | [optional]
|
546
|
+
**filters** | [**Array<String>**](String.md)| Specify the filter for the comments | [optional]
|
535
547
|
|
536
548
|
### Return type
|
537
549
|
|
@@ -543,6 +555,6 @@ Response<([**Array<Comment>**](Comment.md))>
|
|
543
555
|
|
544
556
|
### HTTP request headers
|
545
557
|
|
546
|
-
- **Content-Type**:
|
558
|
+
- **Content-Type**: application/json
|
547
559
|
- **Accept**: application/json
|
548
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<String>** | Search comments by their assigned locales | [optional]
|
10
|
+
**filters** | **Array<String>** | 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: ["someId","otherId"],
|
20
|
+
filters: ["read","unread"])
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -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<String>** | 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: ["read","unread"])
|
19
|
+
```
|
20
|
+
|
21
|
+
|