phrase 2.12.0 → 2.13.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 +19 -13
- data/docs/CommentReaction.md +27 -0
- data/docs/CommentReactionsApi.md +287 -0
- 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 +350 -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_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 +3 -0
- data/spec/api/comment_reactions_api_spec.rb +91 -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/gitlab_sync_history_errors_spec.rb +35 -0
- metadata +224 -211
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0d4702070f78c40d7498d9d68e305cc787640649858e1694ab33c08ea5163ed5
|
4
|
+
data.tar.gz: b0911a27c09fe55d69887601c75aca0f3ac9d7f9a017fa72a4f30cde5e39b880
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 229be1ca50cc632b3377f01308fbda31b6c1c3d3c57a482e4bdf879e46c8ac89b99a620b7473696438ec27d73ae4e51c0b093cfecff44743e84433b60f09ffbd
|
7
|
+
data.tar.gz: a39e428c34afe189ae3ae85151bcbc6e4bcafdbe2e7a49b0240c26c9be50fbec9aa54bcf862b04d62f65e271f69f5a47a008046bd5ddbf46278311e7d228d9b3
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
## [2.13.0](https://github.com/phrase/openapi/compare/ruby-v2.12.0...ruby-v2.13.0) (2023-08-22)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* **TSE-950:** Document comment_reactions endpoints ([#380](https://github.com/phrase/openapi/issues/380)) ([f230244](https://github.com/phrase/openapi/commit/f230244e6e9c069b18edc4c35dd5e290fd14793b))
|
9
|
+
|
10
|
+
|
11
|
+
### Bug Fixes
|
12
|
+
|
13
|
+
* Fix gitlab_sync history status type mismatch ([#363](https://github.com/phrase/openapi/issues/363)) ([ebcaa4e](https://github.com/phrase/openapi/commit/ebcaa4e5dfcb2f73559a56c78b0f2512ca798375))
|
14
|
+
* **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.13.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.13.0.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.
|
62
|
+
(for development, run `gem install --dev ./phrase-2.13.0.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -152,6 +152,10 @@ 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
|
155
159
|
*Phrase::CommentsApi* | [**comment_create**](docs/CommentsApi.md#comment_create) | **POST** /projects/{project_id}/keys/{key_id}/comments | Create a comment
|
156
160
|
*Phrase::CommentsApi* | [**comment_delete**](docs/CommentsApi.md#comment_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{id} | Delete a comment
|
157
161
|
*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 +209,12 @@ Class | Method | HTTP request | Description
|
|
205
209
|
*Phrase::JobCommentsApi* | [**job_comments_list**](docs/JobCommentsApi.md#job_comments_list) | **GET** /projects/{project_id}/jobs/{job_id}/comments | List job comments
|
206
210
|
*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
211
|
*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} |
|
212
|
+
*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
213
|
*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
|
214
|
+
*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
|
215
|
+
*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
|
216
|
+
*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
|
217
|
+
*Phrase::JobLocalesApi* | [**job_locales_list**](docs/JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job target locales
|
214
218
|
*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
219
|
*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
220
|
*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 +309,9 @@ Class | Method | HTTP request | Description
|
|
305
309
|
*Phrase::SpacesApi* | [**space_show**](docs/SpacesApi.md#space_show) | **GET** /accounts/{account_id}/spaces/{id} | Get Space
|
306
310
|
*Phrase::SpacesApi* | [**space_update**](docs/SpacesApi.md#space_update) | **PATCH** /accounts/{account_id}/spaces/{id} | Update Space
|
307
311
|
*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
|
312
|
+
*Phrase::SpacesApi* | [**spaces_projects_create**](docs/SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project to Space
|
313
|
+
*Phrase::SpacesApi* | [**spaces_projects_delete**](docs/SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project from Space
|
314
|
+
*Phrase::SpacesApi* | [**spaces_projects_list**](docs/SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects in Space
|
311
315
|
*Phrase::StyleGuidesApi* | [**styleguide_create**](docs/StyleGuidesApi.md#styleguide_create) | **POST** /projects/{project_id}/styleguides | Create a style guide
|
312
316
|
*Phrase::StyleGuidesApi* | [**styleguide_delete**](docs/StyleGuidesApi.md#styleguide_delete) | **DELETE** /projects/{project_id}/styleguides/{id} | Delete a style guide
|
313
317
|
*Phrase::StyleGuidesApi* | [**styleguide_show**](docs/StyleGuidesApi.md#styleguide_show) | **GET** /projects/{project_id}/styleguides/{id} | Get a single style guide
|
@@ -322,8 +326,8 @@ Class | Method | HTTP request | Description
|
|
322
326
|
*Phrase::TeamsApi* | [**team_show**](docs/TeamsApi.md#team_show) | **GET** /accounts/{account_id}/teams/{id} | Get Team
|
323
327
|
*Phrase::TeamsApi* | [**team_update**](docs/TeamsApi.md#team_update) | **PATCH** /accounts/{account_id}/teams/{id} | Update Team
|
324
328
|
*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
|
329
|
+
*Phrase::TeamsApi* | [**teams_projects_create**](docs/TeamsApi.md#teams_projects_create) | **POST** /accounts/{account_id}/teams/{team_id}/projects | Add Project to Team
|
330
|
+
*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
331
|
*Phrase::TeamsApi* | [**teams_spaces_create**](docs/TeamsApi.md#teams_spaces_create) | **POST** /accounts/{account_id}/teams/{team_id}/spaces | Add Space
|
328
332
|
*Phrase::TeamsApi* | [**teams_spaces_delete**](docs/TeamsApi.md#teams_spaces_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/spaces/{id} | Remove Space
|
329
333
|
*Phrase::TeamsApi* | [**teams_users_create**](docs/TeamsApi.md#teams_users_create) | **POST** /accounts/{account_id}/teams/{team_id}/users | Add User
|
@@ -395,6 +399,7 @@ Class | Method | HTTP request | Description
|
|
395
399
|
- [Phrase::Comment](docs/Comment.md)
|
396
400
|
- [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
|
397
401
|
- [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
|
402
|
+
- [Phrase::CommentReaction](docs/CommentReaction.md)
|
398
403
|
- [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
|
399
404
|
- [Phrase::CurrentUser](docs/CurrentUser.md)
|
400
405
|
- [Phrase::Distribution](docs/Distribution.md)
|
@@ -409,6 +414,7 @@ Class | Method | HTTP request | Description
|
|
409
414
|
- [Phrase::GitlabSyncExport](docs/GitlabSyncExport.md)
|
410
415
|
- [Phrase::GitlabSyncExportParameters](docs/GitlabSyncExportParameters.md)
|
411
416
|
- [Phrase::GitlabSyncHistory](docs/GitlabSyncHistory.md)
|
417
|
+
- [Phrase::GitlabSyncHistoryErrors](docs/GitlabSyncHistoryErrors.md)
|
412
418
|
- [Phrase::GitlabSyncImportParameters](docs/GitlabSyncImportParameters.md)
|
413
419
|
- [Phrase::Glossary](docs/Glossary.md)
|
414
420
|
- [Phrase::GlossaryCreateParameters](docs/GlossaryCreateParameters.md)
|
@@ -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,287 @@
|
|
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
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
#Create a reaction
|
49
|
+
result = api_instance.reaction_create(project_id, key_id, comment_id, opts)
|
50
|
+
pp result
|
51
|
+
rescue Phrase::ApiError => e
|
52
|
+
puts "Exception when calling CommentReactionsApi->reaction_create: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
|
59
|
+
Name | Type | Description | Notes
|
60
|
+
------------- | ------------- | ------------- | -------------
|
61
|
+
**project_id** | **String**| Project ID |
|
62
|
+
**key_id** | **String**| Translation Key ID |
|
63
|
+
**comment_id** | **String**| Comment ID |
|
64
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
65
|
+
**branch** | **String**| specify the branch to use | [optional]
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
Response<([**CommentReaction**](CommentReaction.md))>
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
80
|
+
|
81
|
+
## reaction_delete
|
82
|
+
|
83
|
+
> reaction_delete(project_id, key_id, comment_id, id, opts)
|
84
|
+
|
85
|
+
Delete a reaction
|
86
|
+
|
87
|
+
Delete an existing reaction.
|
88
|
+
|
89
|
+
### Example
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
# load the gem
|
93
|
+
require 'phrase'
|
94
|
+
# setup authorization
|
95
|
+
Phrase.configure do |config|
|
96
|
+
# Configure HTTP basic authorization: Basic
|
97
|
+
config.username = 'YOUR USERNAME'
|
98
|
+
config.password = 'YOUR PASSWORD'
|
99
|
+
|
100
|
+
# Configure API key authorization: Token
|
101
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
102
|
+
config.api_key_prefix['Authorization'] = 'token'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = Phrase::CommentReactionsApi.new
|
106
|
+
project_id = 'project_id_example' # String | Project ID
|
107
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
108
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
109
|
+
id = 'id_example' # String | ID
|
110
|
+
opts = {
|
111
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
112
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
113
|
+
}
|
114
|
+
|
115
|
+
begin
|
116
|
+
#Delete a reaction
|
117
|
+
api_instance.reaction_delete(project_id, key_id, comment_id, id, opts)
|
118
|
+
rescue Phrase::ApiError => e
|
119
|
+
puts "Exception when calling CommentReactionsApi->reaction_delete: #{e}"
|
120
|
+
end
|
121
|
+
```
|
122
|
+
|
123
|
+
### Parameters
|
124
|
+
|
125
|
+
|
126
|
+
Name | Type | Description | Notes
|
127
|
+
------------- | ------------- | ------------- | -------------
|
128
|
+
**project_id** | **String**| Project ID |
|
129
|
+
**key_id** | **String**| Translation Key ID |
|
130
|
+
**comment_id** | **String**| Comment ID |
|
131
|
+
**id** | **String**| ID |
|
132
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
133
|
+
**branch** | **String**| specify the branch to use | [optional]
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
Response<(nil (empty response body))>
|
138
|
+
|
139
|
+
### Authorization
|
140
|
+
|
141
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: Not defined
|
146
|
+
- **Accept**: Not defined
|
147
|
+
|
148
|
+
|
149
|
+
## reaction_show
|
150
|
+
|
151
|
+
> CommentReaction reaction_show(project_id, key_id, comment_id, id, opts)
|
152
|
+
|
153
|
+
Get a single reaction
|
154
|
+
|
155
|
+
Get details on a single reaction.
|
156
|
+
|
157
|
+
### Example
|
158
|
+
|
159
|
+
```ruby
|
160
|
+
# load the gem
|
161
|
+
require 'phrase'
|
162
|
+
# setup authorization
|
163
|
+
Phrase.configure do |config|
|
164
|
+
# Configure HTTP basic authorization: Basic
|
165
|
+
config.username = 'YOUR USERNAME'
|
166
|
+
config.password = 'YOUR PASSWORD'
|
167
|
+
|
168
|
+
# Configure API key authorization: Token
|
169
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
170
|
+
config.api_key_prefix['Authorization'] = 'token'
|
171
|
+
end
|
172
|
+
|
173
|
+
api_instance = Phrase::CommentReactionsApi.new
|
174
|
+
project_id = 'project_id_example' # String | Project ID
|
175
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
176
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
177
|
+
id = 'id_example' # String | ID
|
178
|
+
opts = {
|
179
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
180
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
181
|
+
}
|
182
|
+
|
183
|
+
begin
|
184
|
+
#Get a single reaction
|
185
|
+
result = api_instance.reaction_show(project_id, key_id, comment_id, id, opts)
|
186
|
+
pp result
|
187
|
+
rescue Phrase::ApiError => e
|
188
|
+
puts "Exception when calling CommentReactionsApi->reaction_show: #{e}"
|
189
|
+
end
|
190
|
+
```
|
191
|
+
|
192
|
+
### Parameters
|
193
|
+
|
194
|
+
|
195
|
+
Name | Type | Description | Notes
|
196
|
+
------------- | ------------- | ------------- | -------------
|
197
|
+
**project_id** | **String**| Project ID |
|
198
|
+
**key_id** | **String**| Translation Key ID |
|
199
|
+
**comment_id** | **String**| Comment ID |
|
200
|
+
**id** | **String**| ID |
|
201
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
202
|
+
**branch** | **String**| specify the branch to use | [optional]
|
203
|
+
|
204
|
+
### Return type
|
205
|
+
|
206
|
+
Response<([**CommentReaction**](CommentReaction.md))>
|
207
|
+
|
208
|
+
### Authorization
|
209
|
+
|
210
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
211
|
+
|
212
|
+
### HTTP request headers
|
213
|
+
|
214
|
+
- **Content-Type**: Not defined
|
215
|
+
- **Accept**: application/json
|
216
|
+
|
217
|
+
|
218
|
+
## reactions_list
|
219
|
+
|
220
|
+
> Array<CommentReaction> reactions_list(project_id, key_id, comment_id, opts)
|
221
|
+
|
222
|
+
List reactions
|
223
|
+
|
224
|
+
List all reactions for a comment.
|
225
|
+
|
226
|
+
### Example
|
227
|
+
|
228
|
+
```ruby
|
229
|
+
# load the gem
|
230
|
+
require 'phrase'
|
231
|
+
# setup authorization
|
232
|
+
Phrase.configure do |config|
|
233
|
+
# Configure HTTP basic authorization: Basic
|
234
|
+
config.username = 'YOUR USERNAME'
|
235
|
+
config.password = 'YOUR PASSWORD'
|
236
|
+
|
237
|
+
# Configure API key authorization: Token
|
238
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
239
|
+
config.api_key_prefix['Authorization'] = 'token'
|
240
|
+
end
|
241
|
+
|
242
|
+
api_instance = Phrase::CommentReactionsApi.new
|
243
|
+
project_id = 'project_id_example' # String | Project ID
|
244
|
+
key_id = 'key_id_example' # String | Translation Key ID
|
245
|
+
comment_id = 'comment_id_example' # String | Comment ID
|
246
|
+
opts = {
|
247
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
248
|
+
page: 1, # Integer | Page number
|
249
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
250
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
251
|
+
}
|
252
|
+
|
253
|
+
begin
|
254
|
+
#List reactions
|
255
|
+
result = api_instance.reactions_list(project_id, key_id, comment_id, opts)
|
256
|
+
pp result
|
257
|
+
rescue Phrase::ApiError => e
|
258
|
+
puts "Exception when calling CommentReactionsApi->reactions_list: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
### Parameters
|
263
|
+
|
264
|
+
|
265
|
+
Name | Type | Description | Notes
|
266
|
+
------------- | ------------- | ------------- | -------------
|
267
|
+
**project_id** | **String**| Project ID |
|
268
|
+
**key_id** | **String**| Translation Key ID |
|
269
|
+
**comment_id** | **String**| Comment ID |
|
270
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
271
|
+
**page** | **Integer**| Page number | [optional]
|
272
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
273
|
+
**branch** | **String**| specify the branch to use | [optional]
|
274
|
+
|
275
|
+
### Return type
|
276
|
+
|
277
|
+
Response<([**Array<CommentReaction>**](CommentReaction.md))>
|
278
|
+
|
279
|
+
### Authorization
|
280
|
+
|
281
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
282
|
+
|
283
|
+
### HTTP request headers
|
284
|
+
|
285
|
+
- **Content-Type**: Not defined
|
286
|
+
- **Accept**: application/json
|
287
|
+
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**name** | **String** | Name of the distribution | [optional]
|
8
8
|
**project_id** | **String** | Project id the distribution should be assigned to. | [optional]
|
9
|
-
**platforms** | **Array<String>** | List of platforms the distribution should support. | [optional]
|
9
|
+
**platforms** | **Array<String>** | List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next` | [optional]
|
10
10
|
**locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional]
|
11
11
|
**format_options** | **Hash<String, String>** | Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>. | [optional]
|
12
12
|
**fallback_locales_enabled** | **Boolean** | Use fallback locale if there is no translation in the current locale. | [optional]
|
data/docs/GitlabSyncHistory.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**status** | **
|
7
|
+
**status** | **String** | | [optional]
|
8
8
|
**action** | **String** | | [optional]
|
9
|
-
**errors** | **Array<
|
9
|
+
**errors** | [**Array<GitlabSyncHistoryErrors>**](GitlabSyncHistoryErrors.md) | | [optional]
|
10
10
|
**date** | **DateTime** | | [optional]
|
11
11
|
**details** | [**Object**](.md) | | [optional]
|
12
12
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::GitlabSyncHistoryErrors
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**error** | **String** | | [optional]
|
8
|
+
**message** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::GitlabSyncHistoryErrors.new(error: null,
|
16
|
+
message: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
-
**locale_id** | **String** | locale
|
8
|
+
**locale_id** | **String** | ID of a target locale to update | [optional]
|
9
9
|
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale | [optional]
|
10
10
|
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
|
11
11
|
**translator_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as translators | [optional]
|
data/docs/JobLocalesApi.md
CHANGED
@@ -6,12 +6,12 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**job_locale_complete**](JobLocalesApi.md#job_locale_complete) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete | Complete a job locale
|
8
8
|
[**job_locale_complete_review**](JobLocalesApi.md#job_locale_complete_review) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review | Review a job locale
|
9
|
-
[**job_locale_delete**](JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} |
|
9
|
+
[**job_locale_delete**](JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Remove a target locale from a job
|
10
10
|
[**job_locale_reopen**](JobLocalesApi.md#job_locale_reopen) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen | Reopen a job locale
|
11
|
-
[**job_locale_show**](JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{id} |
|
12
|
-
[**job_locale_update**](JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job locale
|
13
|
-
[**job_locales_create**](JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales |
|
14
|
-
[**job_locales_list**](JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job locales
|
11
|
+
[**job_locale_show**](JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{id} | Show single job target locale
|
12
|
+
[**job_locale_update**](JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job target locale
|
13
|
+
[**job_locales_create**](JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales | Add a target locale to a job
|
14
|
+
[**job_locales_list**](JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job target locales
|
15
15
|
|
16
16
|
|
17
17
|
|
@@ -153,9 +153,9 @@ Response<([**JobLocale**](JobLocale.md))>
|
|
153
153
|
|
154
154
|
> job_locale_delete(project_id, job_id, id, opts)
|
155
155
|
|
156
|
-
|
156
|
+
Remove a target locale from a job
|
157
157
|
|
158
|
-
|
158
|
+
Removes a target locale from a job.
|
159
159
|
|
160
160
|
### Example
|
161
161
|
|
@@ -183,7 +183,7 @@ opts = {
|
|
183
183
|
}
|
184
184
|
|
185
185
|
begin
|
186
|
-
#
|
186
|
+
#Remove a target locale from a job
|
187
187
|
api_instance.job_locale_delete(project_id, job_id, id, opts)
|
188
188
|
rescue Phrase::ApiError => e
|
189
189
|
puts "Exception when calling JobLocalesApi->job_locale_delete: #{e}"
|
@@ -286,9 +286,9 @@ Response<([**JobLocale**](JobLocale.md))>
|
|
286
286
|
|
287
287
|
> JobLocale job_locale_show(project_id, job_id, id, opts)
|
288
288
|
|
289
|
-
|
289
|
+
Show single job target locale
|
290
290
|
|
291
|
-
Get a single
|
291
|
+
Get a single target locale for a given job.
|
292
292
|
|
293
293
|
### Example
|
294
294
|
|
@@ -316,7 +316,7 @@ opts = {
|
|
316
316
|
}
|
317
317
|
|
318
318
|
begin
|
319
|
-
#
|
319
|
+
#Show single job target locale
|
320
320
|
result = api_instance.job_locale_show(project_id, job_id, id, opts)
|
321
321
|
pp result
|
322
322
|
rescue Phrase::ApiError => e
|
@@ -353,9 +353,9 @@ Response<([**JobLocale**](JobLocale.md))>
|
|
353
353
|
|
354
354
|
> JobLocale job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts)
|
355
355
|
|
356
|
-
Update a job locale
|
356
|
+
Update a job target locale
|
357
357
|
|
358
|
-
Update an existing job locale.
|
358
|
+
Update an existing job target locale.
|
359
359
|
|
360
360
|
### Example
|
361
361
|
|
@@ -383,7 +383,7 @@ opts = {
|
|
383
383
|
}
|
384
384
|
|
385
385
|
begin
|
386
|
-
#Update a job locale
|
386
|
+
#Update a job target locale
|
387
387
|
result = api_instance.job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts)
|
388
388
|
pp result
|
389
389
|
rescue Phrase::ApiError => e
|
@@ -420,9 +420,9 @@ Response<([**JobLocale**](JobLocale.md))>
|
|
420
420
|
|
421
421
|
> JobLocale job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
|
422
422
|
|
423
|
-
|
423
|
+
Add a target locale to a job
|
424
424
|
|
425
|
-
|
425
|
+
Adds a target locale to a job.
|
426
426
|
|
427
427
|
### Example
|
428
428
|
|
@@ -449,7 +449,7 @@ opts = {
|
|
449
449
|
}
|
450
450
|
|
451
451
|
begin
|
452
|
-
#
|
452
|
+
#Add a target locale to a job
|
453
453
|
result = api_instance.job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
|
454
454
|
pp result
|
455
455
|
rescue Phrase::ApiError => e
|
@@ -485,9 +485,9 @@ Response<([**JobLocale**](JobLocale.md))>
|
|
485
485
|
|
486
486
|
> Array<JobLocale> job_locales_list(project_id, job_id, opts)
|
487
487
|
|
488
|
-
List job locales
|
488
|
+
List job target locales
|
489
489
|
|
490
|
-
List all
|
490
|
+
List all target locales for a given job.
|
491
491
|
|
492
492
|
### Example
|
493
493
|
|
@@ -516,7 +516,7 @@ opts = {
|
|
516
516
|
}
|
517
517
|
|
518
518
|
begin
|
519
|
-
#List job locales
|
519
|
+
#List job target locales
|
520
520
|
result = api_instance.job_locales_list(project_id, job_id, opts)
|
521
521
|
pp result
|
522
522
|
rescue Phrase::ApiError => e
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
-
**locale_id** | **String** | locale
|
8
|
+
**locale_id** | **String** | ID of a locale to be added |
|
9
9
|
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale as translators | [optional]
|
10
10
|
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
|
11
11
|
**translator_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as translators | [optional]
|
data/docs/LocalesApi.md
CHANGED
@@ -250,7 +250,7 @@ opts = {
|
|
250
250
|
encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
|
251
251
|
skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
|
252
252
|
include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
|
253
|
-
use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow
|
253
|
+
use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
|
254
254
|
fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
|
255
255
|
source_locale_id: 'source_locale_id_example' # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
|
256
256
|
}
|
@@ -287,7 +287,7 @@ Name | Type | Description | Notes
|
|
287
287
|
**encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
|
288
288
|
**skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>. | [optional]
|
289
289
|
**include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional]
|
290
|
-
**use_last_reviewed_version** | **Boolean**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow
|
290
|
+
**use_last_reviewed_version** | **Boolean**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional]
|
291
291
|
**fallback_locale_id** | **String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>. | [optional]
|
292
292
|
**source_locale_id** | **String**| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job. | [optional]
|
293
293
|
|