phrase 2.12.0 → 2.14.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 +4 -4
- data/CHANGELOG.md +21 -0
- data/README.md +25 -13
- data/docs/Comment.md +5 -1
- data/docs/CommentReaction.md +27 -0
- data/docs/CommentReactionsApi.md +289 -0
- data/docs/CommentRepliesApi.md +427 -0
- data/docs/CommentsApi.md +5 -1
- data/docs/DistributionCreateParameters.md +1 -1
- data/docs/GitlabSyncHistory.md +2 -2
- data/docs/GitlabSyncHistoryErrors.md +19 -0
- data/docs/JobLocaleUpdateParameters.md +1 -1
- data/docs/JobLocalesApi.md +20 -20
- data/docs/JobLocalesCreateParameters.md +1 -1
- data/docs/LocalesApi.md +2 -2
- data/docs/SpacesApi.md +9 -9
- data/docs/TeamsApi.md +6 -6
- data/docs/UploadCreateParameters.md +1 -1
- data/docs/UploadsApi.md +2 -2
- data/lib/phrase/api/comment_reactions_api.rb +353 -0
- data/lib/phrase/api/comment_replies_api.rb +523 -0
- data/lib/phrase/api/comments_api.rb +6 -0
- data/lib/phrase/api/job_locales_api.rb +20 -20
- data/lib/phrase/api/locales_api.rb +2 -2
- data/lib/phrase/api/spaces_api.rb +6 -6
- data/lib/phrase/api/teams_api.rb +4 -4
- data/lib/phrase/api/uploads_api.rb +2 -2
- data/lib/phrase/models/comment.rb +24 -4
- data/lib/phrase/models/comment_reaction.rb +239 -0
- data/lib/phrase/models/distribution_create_parameters.rb +1 -1
- data/lib/phrase/models/gitlab_sync_history.rb +2 -2
- data/lib/phrase/models/gitlab_sync_history_errors.rb +203 -0
- data/lib/phrase/models/job_locale_update_parameters.rb +1 -1
- data/lib/phrase/models/job_locales_create_parameters.rb +1 -1
- data/lib/phrase/models/upload_create_parameters.rb +1 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +4 -0
- data/spec/api/comment_reactions_api_spec.rb +92 -0
- data/spec/api/comment_replies_api_spec.rb +126 -0
- data/spec/api/comments_api_spec.rb +2 -0
- data/spec/api/job_locales_api_spec.rb +10 -10
- data/spec/api/locales_api_spec.rb +1 -1
- data/spec/api/spaces_api_spec.rb +3 -3
- data/spec/api/teams_api_spec.rb +2 -2
- data/spec/api/uploads_api_spec.rb +1 -1
- data/spec/models/comment_reaction_spec.rb +59 -0
- data/spec/models/comment_spec.rb +12 -0
- data/spec/models/gitlab_sync_history_errors_spec.rb +35 -0
- metadata +228 -211
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a84d4b1908bfbb105768607982ae6df42c5d29769a83703e9cf4776022cb14dd
|
4
|
+
data.tar.gz: eaef85f36598f65cd86d4cbdadba04d736023835dee31ce9d014c33420c94d7d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 44cad7e58e9a1da63e70197af4b725ba8c287edf61eb3a7d7925caea72f5788c4f0eff38098411ca28279705700cef0ee17ecb600fc0ee4cdbe8b29c1f7b372b
|
7
|
+
data.tar.gz: 800dbacc70321c8e8f3d5c93e48aa7df6f402cb110a0880575b0f77b323f17832a00778cd43c929c52b02ffcf35a89fb6c5d86a5e25ca8c90b35cdad7bef255e
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
## [2.14.0](https://github.com/phrase/openapi/compare/ruby-v2.13.0...ruby-v2.14.0) (2023-08-24)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* **API:** Introduce comment replies endpoints ([#383](https://github.com/phrase/openapi/issues/383)) ([71351ac](https://github.com/phrase/openapi/commit/71351ac285f4f49976092e176c77b09f3485eb65))
|
9
|
+
|
10
|
+
## [2.13.0](https://github.com/phrase/openapi/compare/ruby-v2.12.0...ruby-v2.13.0) (2023-08-22)
|
11
|
+
|
12
|
+
|
13
|
+
### Features
|
14
|
+
|
15
|
+
* **TSE-950:** Document comment_reactions endpoints ([#380](https://github.com/phrase/openapi/issues/380)) ([f230244](https://github.com/phrase/openapi/commit/f230244e6e9c069b18edc4c35dd5e290fd14793b))
|
16
|
+
|
17
|
+
|
18
|
+
### Bug Fixes
|
19
|
+
|
20
|
+
* Fix gitlab_sync history status type mismatch ([#363](https://github.com/phrase/openapi/issues/363)) ([ebcaa4e](https://github.com/phrase/openapi/commit/ebcaa4e5dfcb2f73559a56c78b0f2512ca798375))
|
21
|
+
* **schemas:** Fix gitlab_sync type mismatch ([#373](https://github.com/phrase/openapi/issues/373)) ([1cb1f65](https://github.com/phrase/openapi/commit/1cb1f650598c68afee6e2cd7c3c4ede1484aba35))
|
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.14.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.14.0.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.
|
62
|
+
(for development, run `gem install --dev ./phrase-2.14.0.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -152,6 +152,16 @@ Class | Method | HTTP request | Description
|
|
152
152
|
*Phrase::BranchesApi* | [**branch_show**](docs/BranchesApi.md#branch_show) | **GET** /projects/{project_id}/branches/{name} | Get a single branch
|
153
153
|
*Phrase::BranchesApi* | [**branch_update**](docs/BranchesApi.md#branch_update) | **PATCH** /projects/{project_id}/branches/{name} | Update a branch
|
154
154
|
*Phrase::BranchesApi* | [**branches_list**](docs/BranchesApi.md#branches_list) | **GET** /projects/{project_id}/branches | List branches
|
155
|
+
*Phrase::CommentReactionsApi* | [**reaction_create**](docs/CommentReactionsApi.md#reaction_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions | Create a reaction
|
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
|
+
*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
|
+
*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
|
155
165
|
*Phrase::CommentsApi* | [**comment_create**](docs/CommentsApi.md#comment_create) | **POST** /projects/{project_id}/keys/{key_id}/comments | Create a comment
|
156
166
|
*Phrase::CommentsApi* | [**comment_delete**](docs/CommentsApi.md#comment_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{id} | Delete a comment
|
157
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
|
@@ -205,12 +215,12 @@ Class | Method | HTTP request | Description
|
|
205
215
|
*Phrase::JobCommentsApi* | [**job_comments_list**](docs/JobCommentsApi.md#job_comments_list) | **GET** /projects/{project_id}/jobs/{job_id}/comments | List job comments
|
206
216
|
*Phrase::JobLocalesApi* | [**job_locale_complete**](docs/JobLocalesApi.md#job_locale_complete) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete | Complete a job locale
|
207
217
|
*Phrase::JobLocalesApi* | [**job_locale_complete_review**](docs/JobLocalesApi.md#job_locale_complete_review) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review | Review a job locale
|
208
|
-
*Phrase::JobLocalesApi* | [**job_locale_delete**](docs/JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} |
|
218
|
+
*Phrase::JobLocalesApi* | [**job_locale_delete**](docs/JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Remove a target locale from a job
|
209
219
|
*Phrase::JobLocalesApi* | [**job_locale_reopen**](docs/JobLocalesApi.md#job_locale_reopen) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen | Reopen a job locale
|
210
|
-
*Phrase::JobLocalesApi* | [**job_locale_show**](docs/JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{id} |
|
211
|
-
*Phrase::JobLocalesApi* | [**job_locale_update**](docs/JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job locale
|
212
|
-
*Phrase::JobLocalesApi* | [**job_locales_create**](docs/JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales |
|
213
|
-
*Phrase::JobLocalesApi* | [**job_locales_list**](docs/JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job locales
|
220
|
+
*Phrase::JobLocalesApi* | [**job_locale_show**](docs/JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{id} | Show single job target locale
|
221
|
+
*Phrase::JobLocalesApi* | [**job_locale_update**](docs/JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job target locale
|
222
|
+
*Phrase::JobLocalesApi* | [**job_locales_create**](docs/JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales | Add a target locale to a job
|
223
|
+
*Phrase::JobLocalesApi* | [**job_locales_list**](docs/JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job target locales
|
214
224
|
*Phrase::JobTemplateLocalesApi* | [**job_template_locale_delete**](docs/JobTemplateLocalesApi.md#job_template_locale_delete) | **DELETE** /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Delete a job template locale
|
215
225
|
*Phrase::JobTemplateLocalesApi* | [**job_template_locale_show**](docs/JobTemplateLocalesApi.md#job_template_locale_show) | **GET** /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Get a single job template locale
|
216
226
|
*Phrase::JobTemplateLocalesApi* | [**job_template_locale_update**](docs/JobTemplateLocalesApi.md#job_template_locale_update) | **PATCH** /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Update a job template locale
|
@@ -305,9 +315,9 @@ Class | Method | HTTP request | Description
|
|
305
315
|
*Phrase::SpacesApi* | [**space_show**](docs/SpacesApi.md#space_show) | **GET** /accounts/{account_id}/spaces/{id} | Get Space
|
306
316
|
*Phrase::SpacesApi* | [**space_update**](docs/SpacesApi.md#space_update) | **PATCH** /accounts/{account_id}/spaces/{id} | Update Space
|
307
317
|
*Phrase::SpacesApi* | [**spaces_list**](docs/SpacesApi.md#spaces_list) | **GET** /accounts/{account_id}/spaces | List Spaces
|
308
|
-
*Phrase::SpacesApi* | [**spaces_projects_create**](docs/SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project
|
309
|
-
*Phrase::SpacesApi* | [**spaces_projects_delete**](docs/SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project
|
310
|
-
*Phrase::SpacesApi* | [**spaces_projects_list**](docs/SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects
|
318
|
+
*Phrase::SpacesApi* | [**spaces_projects_create**](docs/SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project to Space
|
319
|
+
*Phrase::SpacesApi* | [**spaces_projects_delete**](docs/SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project from Space
|
320
|
+
*Phrase::SpacesApi* | [**spaces_projects_list**](docs/SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects in Space
|
311
321
|
*Phrase::StyleGuidesApi* | [**styleguide_create**](docs/StyleGuidesApi.md#styleguide_create) | **POST** /projects/{project_id}/styleguides | Create a style guide
|
312
322
|
*Phrase::StyleGuidesApi* | [**styleguide_delete**](docs/StyleGuidesApi.md#styleguide_delete) | **DELETE** /projects/{project_id}/styleguides/{id} | Delete a style guide
|
313
323
|
*Phrase::StyleGuidesApi* | [**styleguide_show**](docs/StyleGuidesApi.md#styleguide_show) | **GET** /projects/{project_id}/styleguides/{id} | Get a single style guide
|
@@ -322,8 +332,8 @@ Class | Method | HTTP request | Description
|
|
322
332
|
*Phrase::TeamsApi* | [**team_show**](docs/TeamsApi.md#team_show) | **GET** /accounts/{account_id}/teams/{id} | Get Team
|
323
333
|
*Phrase::TeamsApi* | [**team_update**](docs/TeamsApi.md#team_update) | **PATCH** /accounts/{account_id}/teams/{id} | Update Team
|
324
334
|
*Phrase::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /accounts/{account_id}/teams | List Teams
|
325
|
-
*Phrase::TeamsApi* | [**teams_projects_create**](docs/TeamsApi.md#teams_projects_create) | **POST** /accounts/{account_id}/teams/{team_id}/projects | Add Project
|
326
|
-
*Phrase::TeamsApi* | [**teams_projects_delete**](docs/TeamsApi.md#teams_projects_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/projects/{id} | Remove Project
|
335
|
+
*Phrase::TeamsApi* | [**teams_projects_create**](docs/TeamsApi.md#teams_projects_create) | **POST** /accounts/{account_id}/teams/{team_id}/projects | Add Project to Team
|
336
|
+
*Phrase::TeamsApi* | [**teams_projects_delete**](docs/TeamsApi.md#teams_projects_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/projects/{id} | Remove Project from Team
|
327
337
|
*Phrase::TeamsApi* | [**teams_spaces_create**](docs/TeamsApi.md#teams_spaces_create) | **POST** /accounts/{account_id}/teams/{team_id}/spaces | Add Space
|
328
338
|
*Phrase::TeamsApi* | [**teams_spaces_delete**](docs/TeamsApi.md#teams_spaces_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/spaces/{id} | Remove Space
|
329
339
|
*Phrase::TeamsApi* | [**teams_users_create**](docs/TeamsApi.md#teams_users_create) | **POST** /accounts/{account_id}/teams/{team_id}/users | Add User
|
@@ -395,6 +405,7 @@ Class | Method | HTTP request | Description
|
|
395
405
|
- [Phrase::Comment](docs/Comment.md)
|
396
406
|
- [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
|
397
407
|
- [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
|
408
|
+
- [Phrase::CommentReaction](docs/CommentReaction.md)
|
398
409
|
- [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
|
399
410
|
- [Phrase::CurrentUser](docs/CurrentUser.md)
|
400
411
|
- [Phrase::Distribution](docs/Distribution.md)
|
@@ -409,6 +420,7 @@ Class | Method | HTTP request | Description
|
|
409
420
|
- [Phrase::GitlabSyncExport](docs/GitlabSyncExport.md)
|
410
421
|
- [Phrase::GitlabSyncExportParameters](docs/GitlabSyncExportParameters.md)
|
411
422
|
- [Phrase::GitlabSyncHistory](docs/GitlabSyncHistory.md)
|
423
|
+
- [Phrase::GitlabSyncHistoryErrors](docs/GitlabSyncHistoryErrors.md)
|
412
424
|
- [Phrase::GitlabSyncImportParameters](docs/GitlabSyncImportParameters.md)
|
413
425
|
- [Phrase::Glossary](docs/Glossary.md)
|
414
426
|
- [Phrase::GlossaryCreateParameters](docs/GlossaryCreateParameters.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
|
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Phrase::CommentReaction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**emoji** | **String** | | [optional]
|
9
|
+
**created_at** | **DateTime** | | [optional]
|
10
|
+
**updated_at** | **DateTime** | | [optional]
|
11
|
+
**comment** | [**Comment**](Comment.md) | | [optional]
|
12
|
+
**user** | [**UserPreview**](UserPreview.md) | | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Phrase'
|
18
|
+
|
19
|
+
instance = Phrase::CommentReaction.new(id: null,
|
20
|
+
emoji: null,
|
21
|
+
created_at: null,
|
22
|
+
updated_at: null,
|
23
|
+
comment: null,
|
24
|
+
user: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,289 @@
|
|
1
|
+
# Phrase::CommentReactionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**reaction_create**](CommentReactionsApi.md#reaction_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions | Create a reaction
|
8
|
+
[**reaction_delete**](CommentReactionsApi.md#reaction_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Delete a reaction
|
9
|
+
[**reaction_show**](CommentReactionsApi.md#reaction_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Get a single reaction
|
10
|
+
[**reactions_list**](CommentReactionsApi.md#reactions_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions | List reactions
|
11
|
+
|
12
|
+
|
13
|
+
|
14
|
+
## reaction_create
|
15
|
+
|
16
|
+
> CommentReaction reaction_create(project_id, key_id, comment_id, opts)
|
17
|
+
|
18
|
+
Create a reaction
|
19
|
+
|
20
|
+
Create a new reaction for a comment.
|
21
|
+
|
22
|
+
### Example
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'phrase'
|
27
|
+
# setup authorization
|
28
|
+
Phrase.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: Basic
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
|
33
|
+
# Configure API key authorization: Token
|
34
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
35
|
+
config.api_key_prefix['Authorization'] = 'token'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = Phrase::CommentReactionsApi.new
|
39
|
+
project_id = 'project_id_example' # String | Project ID
|
40
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
41
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
42
|
+
opts = {
|
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
|
45
|
+
emoji: '👍' # String | specify the emoji for the reaction
|
46
|
+
}
|
47
|
+
|
48
|
+
begin
|
49
|
+
#Create a reaction
|
50
|
+
result = api_instance.reaction_create(project_id, key_id, comment_id, opts)
|
51
|
+
pp result
|
52
|
+
rescue Phrase::ApiError => e
|
53
|
+
puts "Exception when calling CommentReactionsApi->reaction_create: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
### Parameters
|
58
|
+
|
59
|
+
|
60
|
+
Name | Type | Description | Notes
|
61
|
+
------------- | ------------- | ------------- | -------------
|
62
|
+
**project_id** | **String**| Project ID |
|
63
|
+
**key_id** | **String**| Translation Key ID |
|
64
|
+
**comment_id** | **String**| Comment ID |
|
65
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
66
|
+
**branch** | **String**| specify the branch to use | [optional]
|
67
|
+
**emoji** | **String**| specify the emoji for the reaction | [optional]
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
Response<([**CommentReaction**](CommentReaction.md))>
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: Not defined
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## reaction_delete
|
84
|
+
|
85
|
+
> reaction_delete(project_id, key_id, comment_id, id, opts)
|
86
|
+
|
87
|
+
Delete a reaction
|
88
|
+
|
89
|
+
Delete an existing reaction.
|
90
|
+
|
91
|
+
### Example
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
# load the gem
|
95
|
+
require 'phrase'
|
96
|
+
# setup authorization
|
97
|
+
Phrase.configure do |config|
|
98
|
+
# Configure HTTP basic authorization: Basic
|
99
|
+
config.username = 'YOUR USERNAME'
|
100
|
+
config.password = 'YOUR PASSWORD'
|
101
|
+
|
102
|
+
# Configure API key authorization: Token
|
103
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
104
|
+
config.api_key_prefix['Authorization'] = 'token'
|
105
|
+
end
|
106
|
+
|
107
|
+
api_instance = Phrase::CommentReactionsApi.new
|
108
|
+
project_id = 'project_id_example' # String | Project ID
|
109
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
110
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
111
|
+
id = 'id_example' # String | ID
|
112
|
+
opts = {
|
113
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
114
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
115
|
+
}
|
116
|
+
|
117
|
+
begin
|
118
|
+
#Delete a reaction
|
119
|
+
api_instance.reaction_delete(project_id, key_id, comment_id, id, opts)
|
120
|
+
rescue Phrase::ApiError => e
|
121
|
+
puts "Exception when calling CommentReactionsApi->reaction_delete: #{e}"
|
122
|
+
end
|
123
|
+
```
|
124
|
+
|
125
|
+
### Parameters
|
126
|
+
|
127
|
+
|
128
|
+
Name | Type | Description | Notes
|
129
|
+
------------- | ------------- | ------------- | -------------
|
130
|
+
**project_id** | **String**| Project ID |
|
131
|
+
**key_id** | **String**| Translation Key ID |
|
132
|
+
**comment_id** | **String**| Comment ID |
|
133
|
+
**id** | **String**| ID |
|
134
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
135
|
+
**branch** | **String**| specify the branch to use | [optional]
|
136
|
+
|
137
|
+
### Return type
|
138
|
+
|
139
|
+
Response<(nil (empty response body))>
|
140
|
+
|
141
|
+
### Authorization
|
142
|
+
|
143
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
144
|
+
|
145
|
+
### HTTP request headers
|
146
|
+
|
147
|
+
- **Content-Type**: Not defined
|
148
|
+
- **Accept**: Not defined
|
149
|
+
|
150
|
+
|
151
|
+
## reaction_show
|
152
|
+
|
153
|
+
> CommentReaction reaction_show(project_id, key_id, comment_id, id, opts)
|
154
|
+
|
155
|
+
Get a single reaction
|
156
|
+
|
157
|
+
Get details on a single reaction.
|
158
|
+
|
159
|
+
### Example
|
160
|
+
|
161
|
+
```ruby
|
162
|
+
# load the gem
|
163
|
+
require 'phrase'
|
164
|
+
# setup authorization
|
165
|
+
Phrase.configure do |config|
|
166
|
+
# Configure HTTP basic authorization: Basic
|
167
|
+
config.username = 'YOUR USERNAME'
|
168
|
+
config.password = 'YOUR PASSWORD'
|
169
|
+
|
170
|
+
# Configure API key authorization: Token
|
171
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
172
|
+
config.api_key_prefix['Authorization'] = 'token'
|
173
|
+
end
|
174
|
+
|
175
|
+
api_instance = Phrase::CommentReactionsApi.new
|
176
|
+
project_id = 'project_id_example' # String | Project ID
|
177
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
178
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
179
|
+
id = 'id_example' # String | ID
|
180
|
+
opts = {
|
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
|
183
|
+
}
|
184
|
+
|
185
|
+
begin
|
186
|
+
#Get a single reaction
|
187
|
+
result = api_instance.reaction_show(project_id, key_id, comment_id, id, opts)
|
188
|
+
pp result
|
189
|
+
rescue Phrase::ApiError => e
|
190
|
+
puts "Exception when calling CommentReactionsApi->reaction_show: #{e}"
|
191
|
+
end
|
192
|
+
```
|
193
|
+
|
194
|
+
### Parameters
|
195
|
+
|
196
|
+
|
197
|
+
Name | Type | Description | Notes
|
198
|
+
------------- | ------------- | ------------- | -------------
|
199
|
+
**project_id** | **String**| Project ID |
|
200
|
+
**key_id** | **String**| Translation Key ID |
|
201
|
+
**comment_id** | **String**| Comment ID |
|
202
|
+
**id** | **String**| ID |
|
203
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
204
|
+
**branch** | **String**| specify the branch to use | [optional]
|
205
|
+
|
206
|
+
### Return type
|
207
|
+
|
208
|
+
Response<([**CommentReaction**](CommentReaction.md))>
|
209
|
+
|
210
|
+
### Authorization
|
211
|
+
|
212
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
213
|
+
|
214
|
+
### HTTP request headers
|
215
|
+
|
216
|
+
- **Content-Type**: Not defined
|
217
|
+
- **Accept**: application/json
|
218
|
+
|
219
|
+
|
220
|
+
## reactions_list
|
221
|
+
|
222
|
+
> Array<CommentReaction> reactions_list(project_id, key_id, comment_id, opts)
|
223
|
+
|
224
|
+
List reactions
|
225
|
+
|
226
|
+
List all reactions for a comment.
|
227
|
+
|
228
|
+
### Example
|
229
|
+
|
230
|
+
```ruby
|
231
|
+
# load the gem
|
232
|
+
require 'phrase'
|
233
|
+
# setup authorization
|
234
|
+
Phrase.configure do |config|
|
235
|
+
# Configure HTTP basic authorization: Basic
|
236
|
+
config.username = 'YOUR USERNAME'
|
237
|
+
config.password = 'YOUR PASSWORD'
|
238
|
+
|
239
|
+
# Configure API key authorization: Token
|
240
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
241
|
+
config.api_key_prefix['Authorization'] = 'token'
|
242
|
+
end
|
243
|
+
|
244
|
+
api_instance = Phrase::CommentReactionsApi.new
|
245
|
+
project_id = 'project_id_example' # String | Project ID
|
246
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
247
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
248
|
+
opts = {
|
249
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
250
|
+
page: 1, # Integer | Page number
|
251
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
252
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
253
|
+
}
|
254
|
+
|
255
|
+
begin
|
256
|
+
#List reactions
|
257
|
+
result = api_instance.reactions_list(project_id, key_id, comment_id, opts)
|
258
|
+
pp result
|
259
|
+
rescue Phrase::ApiError => e
|
260
|
+
puts "Exception when calling CommentReactionsApi->reactions_list: #{e}"
|
261
|
+
end
|
262
|
+
```
|
263
|
+
|
264
|
+
### Parameters
|
265
|
+
|
266
|
+
|
267
|
+
Name | Type | Description | Notes
|
268
|
+
------------- | ------------- | ------------- | -------------
|
269
|
+
**project_id** | **String**| Project ID |
|
270
|
+
**key_id** | **String**| Translation Key ID |
|
271
|
+
**comment_id** | **String**| Comment ID |
|
272
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
273
|
+
**page** | **Integer**| Page number | [optional]
|
274
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
275
|
+
**branch** | **String**| specify the branch to use | [optional]
|
276
|
+
|
277
|
+
### Return type
|
278
|
+
|
279
|
+
Response<([**Array<CommentReaction>**](CommentReaction.md))>
|
280
|
+
|
281
|
+
### Authorization
|
282
|
+
|
283
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
284
|
+
|
285
|
+
### HTTP request headers
|
286
|
+
|
287
|
+
- **Content-Type**: Not defined
|
288
|
+
- **Accept**: application/json
|
289
|
+
|