phrase 3.7.1 → 4.3.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 +56 -0
- data/README.md +13 -37
- data/docs/JobDetails.md +2 -0
- data/docs/JobKeysDeleteParameters.md +19 -0
- data/docs/JobsApi.md +16 -14
- data/docs/KeyCreateParameters.md +1 -1
- data/docs/KeyUpdateParameters.md +1 -1
- data/docs/KeysApi.md +4 -4
- data/docs/KeysExcludeParameters.md +1 -1
- data/docs/KeysIncludeParameters.md +1 -1
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/LocalesApi.md +3 -1
- data/docs/ProjectCreateParameters.md +1 -1
- data/docs/ProjectUpdateParameters.md +4 -2
- data/docs/QualityPerformanceScoreApi.md +8 -8
- data/docs/QualityPerformanceScoreList200Response.md +21 -0
- data/docs/QualityPerformanceScoreList200ResponseAnyOf.md +19 -0
- data/docs/QualityPerformanceScoreList200ResponseAnyOfData.md +17 -0
- data/docs/{ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md → QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner.md} +2 -2
- data/docs/{ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md → QualityPerformanceScoreList200ResponseAnyOfErrorsInner.md} +2 -2
- data/docs/{ProjectsQualityPerformanceScoreRequest.md → QualityPerformanceScoreListRequest.md} +2 -2
- data/docs/RepoSyncEvent.md +3 -3
- data/docs/RepoSyncEventsApi.md +138 -0
- data/docs/RepoSyncsApi.md +2 -132
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/Upload.md +3 -1
- data/lib/phrase/api/jobs_api.rb +24 -16
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locales_api.rb +3 -0
- data/lib/phrase/api/quality_performance_score_api.rb +15 -15
- data/lib/phrase/api/repo_sync_events_api.rb +160 -0
- data/lib/phrase/api/repo_syncs_api.rb +4 -154
- data/lib/phrase/models/job_details.rb +10 -1
- data/lib/phrase/models/job_keys_delete_parameters.rb +214 -0
- data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
- data/lib/phrase/models/keys_include_parameters.rb +1 -1
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/project_update_parameters.rb +48 -4
- data/lib/phrase/models/{projects_quality_performance_score200_response.rb → quality_performance_score_list200_response.rb} +6 -6
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of.rb → quality_performance_score_list200_response_any_of.rb} +5 -5
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of_data.rb → quality_performance_score_list200_response_any_of_data.rb} +4 -4
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of_data_translations_inner.rb → quality_performance_score_list200_response_any_of_data_translations_inner.rb} +3 -3
- data/lib/phrase/models/{projects_quality_performance_score200_response_any_of_errors_inner.rb → quality_performance_score_list200_response_any_of_errors_inner.rb} +3 -3
- data/lib/phrase/models/{projects_quality_performance_score_request.rb → quality_performance_score_list_request.rb} +3 -3
- data/lib/phrase/models/repo_sync_event.rb +15 -15
- data/lib/phrase/models/upload.rb +14 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +8 -22
- data/spec/api/jobs_api_spec.rb +6 -5
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/quality_performance_score_api_spec.rb +4 -4
- data/spec/api/repo_sync_events_api_spec.rb +52 -0
- data/spec/api/repo_syncs_api_spec.rb +2 -31
- data/spec/models/job_details_spec.rb +6 -0
- data/spec/models/{gitlab_sync_export_spec.rb → job_keys_delete_parameters_spec.rb} +8 -8
- data/spec/models/project_update_parameters_spec.rb +10 -0
- data/spec/models/quality_performance_score_list200_response_any_of_data_spec.rb +29 -0
- data/spec/models/{projects_quality_performance_score200_response_any_of_data_translations_inner_spec.rb → quality_performance_score_list200_response_any_of_data_translations_inner_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score200_response_any_of_errors_inner_spec.rb → quality_performance_score_list200_response_any_of_errors_inner_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score200_response_any_of_spec.rb → quality_performance_score_list200_response_any_of_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score200_response_spec.rb → quality_performance_score_list200_response_spec.rb} +6 -6
- data/spec/models/{projects_quality_performance_score_request_spec.rb → quality_performance_score_list_request_spec.rb} +6 -6
- data/spec/models/repo_sync_event_spec.rb +2 -2
- data/spec/models/upload_spec.rb +6 -0
- metadata +265 -321
- data/docs/BitbucketSync.md +0 -27
- data/docs/BitbucketSyncApi.md +0 -197
- data/docs/BitbucketSyncExportParameters.md +0 -17
- data/docs/BitbucketSyncExportResponse.md +0 -17
- data/docs/BitbucketSyncImportParameters.md +0 -17
- data/docs/GitHubSyncApi.md +0 -130
- data/docs/GitLabSyncApi.md +0 -463
- data/docs/GithubSyncExportParameters.md +0 -17
- data/docs/GithubSyncImportParameters.md +0 -17
- data/docs/GitlabSync.md +0 -37
- data/docs/GitlabSyncExport.md +0 -19
- data/docs/GitlabSyncExportParameters.md +0 -17
- data/docs/GitlabSyncHistory.md +0 -25
- data/docs/GitlabSyncHistoryErrorsInner.md +0 -19
- data/docs/GitlabSyncImportParameters.md +0 -17
- data/docs/ProjectsQualityPerformanceScore200Response.md +0 -21
- data/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md +0 -19
- data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md +0 -17
- data/docs/RepoSyncEventErrorsInner.md +0 -16
- data/lib/phrase/api/bitbucket_sync_api.rb +0 -219
- data/lib/phrase/api/git_hub_sync_api.rb +0 -146
- data/lib/phrase/api/git_lab_sync_api.rb +0 -510
- data/lib/phrase/models/bitbucket_sync.rb +0 -243
- data/lib/phrase/models/bitbucket_sync_export_parameters.rb +0 -197
- data/lib/phrase/models/bitbucket_sync_export_response.rb +0 -196
- data/lib/phrase/models/bitbucket_sync_import_parameters.rb +0 -197
- data/lib/phrase/models/github_sync_export_parameters.rb +0 -197
- data/lib/phrase/models/github_sync_import_parameters.rb +0 -197
- data/lib/phrase/models/gitlab_sync.rb +0 -286
- data/lib/phrase/models/gitlab_sync_export.rb +0 -205
- data/lib/phrase/models/gitlab_sync_export_parameters.rb +0 -197
- data/lib/phrase/models/gitlab_sync_history.rb +0 -234
- data/lib/phrase/models/gitlab_sync_history_errors_inner.rb +0 -205
- data/lib/phrase/models/gitlab_sync_import_parameters.rb +0 -197
- data/lib/phrase/models/repo_sync_event_errors_inner.rb +0 -207
- data/spec/api/bitbucket_sync_api_spec.rb +0 -64
- data/spec/api/git_hub_sync_api_spec.rb +0 -49
- data/spec/api/git_lab_sync_api_spec.rb +0 -125
- data/spec/models/bitbucket_sync_export_parameters_spec.rb +0 -29
- data/spec/models/bitbucket_sync_export_response_spec.rb +0 -29
- data/spec/models/bitbucket_sync_import_parameters_spec.rb +0 -29
- data/spec/models/bitbucket_sync_spec.rb +0 -59
- data/spec/models/github_sync_export_parameters_spec.rb +0 -29
- data/spec/models/github_sync_import_parameters_spec.rb +0 -29
- data/spec/models/gitlab_sync_export_parameters_spec.rb +0 -29
- data/spec/models/gitlab_sync_history_errors_inner_spec.rb +0 -35
- data/spec/models/gitlab_sync_history_spec.rb +0 -53
- data/spec/models/gitlab_sync_import_parameters_spec.rb +0 -29
- data/spec/models/gitlab_sync_spec.rb +0 -89
- data/spec/models/projects_quality_performance_score200_response_any_of_data_spec.rb +0 -29
- data/spec/models/repo_sync_event_errors_inner_spec.rb +0 -23
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.phrase.com/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
7
|
+
[**quality_performance_score_list**](QualityPerformanceScoreApi.md#quality_performance_score_list) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
|
8
8
|
|
9
9
|
|
10
10
|
|
11
|
-
##
|
11
|
+
## quality_performance_score_list
|
12
12
|
|
13
|
-
>
|
13
|
+
> QualityPerformanceScoreList200Response quality_performance_score_list(project_id, quality_performance_score_list_request, opts)
|
14
14
|
|
15
15
|
Get Translation Quality
|
16
16
|
|
@@ -34,17 +34,17 @@ end
|
|
34
34
|
|
35
35
|
api_instance = Phrase::QualityPerformanceScoreApi.new
|
36
36
|
project_id = 'project_id_example' # String | Project ID
|
37
|
-
|
37
|
+
quality_performance_score_list_request = Phrase::QualityPerformanceScoreListRequest.new # QualityPerformanceScoreListRequest |
|
38
38
|
opts = {
|
39
39
|
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
40
40
|
}
|
41
41
|
|
42
42
|
begin
|
43
43
|
#Get Translation Quality
|
44
|
-
result = api_instance.
|
44
|
+
result = api_instance.quality_performance_score_list(project_id, quality_performance_score_list_request, opts)
|
45
45
|
pp result
|
46
46
|
rescue Phrase::ApiError => e
|
47
|
-
puts "Exception when calling QualityPerformanceScoreApi->
|
47
|
+
puts "Exception when calling QualityPerformanceScoreApi->quality_performance_score_list: #{e}"
|
48
48
|
end
|
49
49
|
```
|
50
50
|
|
@@ -54,12 +54,12 @@ end
|
|
54
54
|
Name | Type | Description | Notes
|
55
55
|
------------- | ------------- | ------------- | -------------
|
56
56
|
**project_id** | **String**| Project ID |
|
57
|
-
**
|
57
|
+
**quality_performance_score_list_request** | [**QualityPerformanceScoreListRequest**](QualityPerformanceScoreListRequest.md)| |
|
58
58
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
59
59
|
|
60
60
|
### Return type
|
61
61
|
|
62
|
-
Response<([**
|
62
|
+
Response<([**QualityPerformanceScoreList200Response**](QualityPerformanceScoreList200Response.md))>
|
63
63
|
|
64
64
|
### Authorization
|
65
65
|
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Phrase::QualityPerformanceScoreList200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**error** | [**ErrorError**](ErrorError.md) | | [optional]
|
8
|
+
**data** | [**QualityPerformanceScoreList200ResponseAnyOfData**](QualityPerformanceScoreList200ResponseAnyOfData.md) | | [optional]
|
9
|
+
**errors** | [**Array<QualityPerformanceScoreList200ResponseAnyOfErrorsInner>**](QualityPerformanceScoreList200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'Phrase'
|
15
|
+
|
16
|
+
instance = Phrase::QualityPerformanceScoreList200Response.new(error: null,
|
17
|
+
data: null,
|
18
|
+
errors: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::QualityPerformanceScoreList200ResponseAnyOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**data** | [**QualityPerformanceScoreList200ResponseAnyOfData**](QualityPerformanceScoreList200ResponseAnyOfData.md) | | [optional]
|
8
|
+
**errors** | [**Array<QualityPerformanceScoreList200ResponseAnyOfErrorsInner>**](QualityPerformanceScoreList200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::QualityPerformanceScoreList200ResponseAnyOf.new(data: null,
|
16
|
+
errors: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Phrase::QualityPerformanceScoreList200ResponseAnyOfData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**translations** | [**Array<QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner>**](QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'Phrase'
|
13
|
+
|
14
|
+
instance = Phrase::QualityPerformanceScoreList200ResponseAnyOfData.new(translations: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Phrase::
|
1
|
+
# Phrase::QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
```ruby
|
14
14
|
require 'Phrase'
|
15
15
|
|
16
|
-
instance = Phrase::
|
16
|
+
instance = Phrase::QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner.new(engine: null,
|
17
17
|
score: null,
|
18
18
|
id: null)
|
19
19
|
```
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Phrase::
|
1
|
+
# Phrase::QualityPerformanceScoreList200ResponseAnyOfErrorsInner
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
```ruby
|
14
14
|
require 'Phrase'
|
15
15
|
|
16
|
-
instance = Phrase::
|
16
|
+
instance = Phrase::QualityPerformanceScoreList200ResponseAnyOfErrorsInner.new(message: null,
|
17
17
|
code: null,
|
18
18
|
id: null)
|
19
19
|
```
|
data/docs/{ProjectsQualityPerformanceScoreRequest.md → QualityPerformanceScoreListRequest.md}
RENAMED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Phrase::
|
1
|
+
# Phrase::QualityPerformanceScoreListRequest
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
```ruby
|
12
12
|
require 'Phrase'
|
13
13
|
|
14
|
-
instance = Phrase::
|
14
|
+
instance = Phrase::QualityPerformanceScoreListRequest.new(translation_ids: null)
|
15
15
|
```
|
16
16
|
|
17
17
|
|
data/docs/RepoSyncEvent.md
CHANGED
@@ -5,12 +5,12 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**id** | **String** | | [optional]
|
8
|
-
**
|
8
|
+
**type** | **String** | | [optional]
|
9
9
|
**created_at** | **Time** | | [optional]
|
10
10
|
**status** | **String** | | [optional]
|
11
11
|
**pull_request_url** | **String** | URL of the pull request created on export | [optional]
|
12
12
|
**auto_import** | **Boolean** | Whether the import was triggered by the repo push event | [optional]
|
13
|
-
**errors** |
|
13
|
+
**errors** | **Array<String>** | List of error messages, in case of failure | [optional]
|
14
14
|
|
15
15
|
## Code Sample
|
16
16
|
|
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
|
18
18
|
require 'Phrase'
|
19
19
|
|
20
20
|
instance = Phrase::RepoSyncEvent.new(id: null,
|
21
|
-
|
21
|
+
type: null,
|
22
22
|
created_at: null,
|
23
23
|
status: null,
|
24
24
|
pull_request_url: null,
|
@@ -0,0 +1,138 @@
|
|
1
|
+
# Phrase::RepoSyncEventsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**repo_sync_event_list**](RepoSyncEventsApi.md#repo_sync_event_list) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
|
8
|
+
[**repo_sync_event_show**](RepoSyncEventsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
|
9
|
+
|
10
|
+
|
11
|
+
|
12
|
+
## repo_sync_event_list
|
13
|
+
|
14
|
+
> Array<RepoSyncEvent> repo_sync_event_list(account_id, id, opts)
|
15
|
+
|
16
|
+
Repository Syncs History
|
17
|
+
|
18
|
+
Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'phrase'
|
25
|
+
# setup authorization
|
26
|
+
Phrase.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: Basic
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
|
31
|
+
# Configure API key authorization: Token
|
32
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
33
|
+
config.api_key_prefix['Authorization'] = 'token'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = Phrase::RepoSyncEventsApi.new
|
37
|
+
account_id = 'account_id_example' # String | Account ID
|
38
|
+
id = 'id_example' # String | ID
|
39
|
+
opts = {
|
40
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
41
|
+
}
|
42
|
+
|
43
|
+
begin
|
44
|
+
#Repository Syncs History
|
45
|
+
result = api_instance.repo_sync_event_list(account_id, id, opts)
|
46
|
+
pp result
|
47
|
+
rescue Phrase::ApiError => e
|
48
|
+
puts "Exception when calling RepoSyncEventsApi->repo_sync_event_list: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**account_id** | **String**| Account ID |
|
58
|
+
**id** | **String**| ID |
|
59
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
60
|
+
|
61
|
+
### Return type
|
62
|
+
|
63
|
+
Response<([**Array<RepoSyncEvent>**](RepoSyncEvent.md))>
|
64
|
+
|
65
|
+
### Authorization
|
66
|
+
|
67
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
68
|
+
|
69
|
+
### HTTP request headers
|
70
|
+
|
71
|
+
- **Content-Type**: Not defined
|
72
|
+
- **Accept**: application/json
|
73
|
+
|
74
|
+
|
75
|
+
## repo_sync_event_show
|
76
|
+
|
77
|
+
> RepoSyncEvent repo_sync_event_show(account_id, repo_sync_id, id, opts)
|
78
|
+
|
79
|
+
Get a single Repo Sync Event
|
80
|
+
|
81
|
+
Shows a single Repo Sync event.
|
82
|
+
|
83
|
+
### Example
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
# load the gem
|
87
|
+
require 'phrase'
|
88
|
+
# setup authorization
|
89
|
+
Phrase.configure do |config|
|
90
|
+
# Configure HTTP basic authorization: Basic
|
91
|
+
config.username = 'YOUR USERNAME'
|
92
|
+
config.password = 'YOUR PASSWORD'
|
93
|
+
|
94
|
+
# Configure API key authorization: Token
|
95
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
96
|
+
config.api_key_prefix['Authorization'] = 'token'
|
97
|
+
end
|
98
|
+
|
99
|
+
api_instance = Phrase::RepoSyncEventsApi.new
|
100
|
+
account_id = 'account_id_example' # String | Account ID
|
101
|
+
repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID
|
102
|
+
id = 'id_example' # String | ID
|
103
|
+
opts = {
|
104
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
105
|
+
}
|
106
|
+
|
107
|
+
begin
|
108
|
+
#Get a single Repo Sync Event
|
109
|
+
result = api_instance.repo_sync_event_show(account_id, repo_sync_id, id, opts)
|
110
|
+
pp result
|
111
|
+
rescue Phrase::ApiError => e
|
112
|
+
puts "Exception when calling RepoSyncEventsApi->repo_sync_event_show: #{e}"
|
113
|
+
end
|
114
|
+
```
|
115
|
+
|
116
|
+
### Parameters
|
117
|
+
|
118
|
+
|
119
|
+
Name | Type | Description | Notes
|
120
|
+
------------- | ------------- | ------------- | -------------
|
121
|
+
**account_id** | **String**| Account ID |
|
122
|
+
**repo_sync_id** | **String**| Repo Sync ID |
|
123
|
+
**id** | **String**| ID |
|
124
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
125
|
+
|
126
|
+
### Return type
|
127
|
+
|
128
|
+
Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
129
|
+
|
130
|
+
### Authorization
|
131
|
+
|
132
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
133
|
+
|
134
|
+
### HTTP request headers
|
135
|
+
|
136
|
+
- **Content-Type**: Not defined
|
137
|
+
- **Accept**: application/json
|
138
|
+
|
data/docs/RepoSyncsApi.md
CHANGED
@@ -6,8 +6,6 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**repo_sync_activate**](RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync
|
8
8
|
[**repo_sync_deactivate**](RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync
|
9
|
-
[**repo_sync_event_show**](RepoSyncsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
|
10
|
-
[**repo_sync_events**](RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
|
11
9
|
[**repo_sync_export**](RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository
|
12
10
|
[**repo_sync_import**](RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository
|
13
11
|
[**repo_sync_list**](RepoSyncsApi.md#repo_sync_list) | **GET** /accounts/{account_id}/repo_syncs | Get Repo Syncs
|
@@ -141,141 +139,13 @@ Response<([**RepoSync**](RepoSync.md))>
|
|
141
139
|
- **Accept**: application/json
|
142
140
|
|
143
141
|
|
144
|
-
## repo_sync_event_show
|
145
|
-
|
146
|
-
> RepoSyncEvent repo_sync_event_show(account_id, repo_sync_id, id, opts)
|
147
|
-
|
148
|
-
Get a single Repo Sync Event
|
149
|
-
|
150
|
-
Shows a single Repo Sync event.
|
151
|
-
|
152
|
-
### Example
|
153
|
-
|
154
|
-
```ruby
|
155
|
-
# load the gem
|
156
|
-
require 'phrase'
|
157
|
-
# setup authorization
|
158
|
-
Phrase.configure do |config|
|
159
|
-
# Configure HTTP basic authorization: Basic
|
160
|
-
config.username = 'YOUR USERNAME'
|
161
|
-
config.password = 'YOUR PASSWORD'
|
162
|
-
|
163
|
-
# Configure API key authorization: Token
|
164
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
165
|
-
config.api_key_prefix['Authorization'] = 'token'
|
166
|
-
end
|
167
|
-
|
168
|
-
api_instance = Phrase::RepoSyncsApi.new
|
169
|
-
account_id = 'account_id_example' # String | Account ID
|
170
|
-
repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID
|
171
|
-
id = 'id_example' # String | ID
|
172
|
-
opts = {
|
173
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
174
|
-
}
|
175
|
-
|
176
|
-
begin
|
177
|
-
#Get a single Repo Sync Event
|
178
|
-
result = api_instance.repo_sync_event_show(account_id, repo_sync_id, id, opts)
|
179
|
-
pp result
|
180
|
-
rescue Phrase::ApiError => e
|
181
|
-
puts "Exception when calling RepoSyncsApi->repo_sync_event_show: #{e}"
|
182
|
-
end
|
183
|
-
```
|
184
|
-
|
185
|
-
### Parameters
|
186
|
-
|
187
|
-
|
188
|
-
Name | Type | Description | Notes
|
189
|
-
------------- | ------------- | ------------- | -------------
|
190
|
-
**account_id** | **String**| Account ID |
|
191
|
-
**repo_sync_id** | **String**| Repo Sync ID |
|
192
|
-
**id** | **String**| ID |
|
193
|
-
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
194
|
-
|
195
|
-
### Return type
|
196
|
-
|
197
|
-
Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
198
|
-
|
199
|
-
### Authorization
|
200
|
-
|
201
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
202
|
-
|
203
|
-
### HTTP request headers
|
204
|
-
|
205
|
-
- **Content-Type**: Not defined
|
206
|
-
- **Accept**: application/json
|
207
|
-
|
208
|
-
|
209
|
-
## repo_sync_events
|
210
|
-
|
211
|
-
> Array<RepoSyncEvent> repo_sync_events(account_id, id, opts)
|
212
|
-
|
213
|
-
Repository Syncs History
|
214
|
-
|
215
|
-
Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync.
|
216
|
-
|
217
|
-
### Example
|
218
|
-
|
219
|
-
```ruby
|
220
|
-
# load the gem
|
221
|
-
require 'phrase'
|
222
|
-
# setup authorization
|
223
|
-
Phrase.configure do |config|
|
224
|
-
# Configure HTTP basic authorization: Basic
|
225
|
-
config.username = 'YOUR USERNAME'
|
226
|
-
config.password = 'YOUR PASSWORD'
|
227
|
-
|
228
|
-
# Configure API key authorization: Token
|
229
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
230
|
-
config.api_key_prefix['Authorization'] = 'token'
|
231
|
-
end
|
232
|
-
|
233
|
-
api_instance = Phrase::RepoSyncsApi.new
|
234
|
-
account_id = 'account_id_example' # String | Account ID
|
235
|
-
id = 'id_example' # String | ID
|
236
|
-
opts = {
|
237
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
238
|
-
}
|
239
|
-
|
240
|
-
begin
|
241
|
-
#Repository Syncs History
|
242
|
-
result = api_instance.repo_sync_events(account_id, id, opts)
|
243
|
-
pp result
|
244
|
-
rescue Phrase::ApiError => e
|
245
|
-
puts "Exception when calling RepoSyncsApi->repo_sync_events: #{e}"
|
246
|
-
end
|
247
|
-
```
|
248
|
-
|
249
|
-
### Parameters
|
250
|
-
|
251
|
-
|
252
|
-
Name | Type | Description | Notes
|
253
|
-
------------- | ------------- | ------------- | -------------
|
254
|
-
**account_id** | **String**| Account ID |
|
255
|
-
**id** | **String**| ID |
|
256
|
-
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
257
|
-
|
258
|
-
### Return type
|
259
|
-
|
260
|
-
Response<([**Array<RepoSyncEvent>**](RepoSyncEvent.md))>
|
261
|
-
|
262
|
-
### Authorization
|
263
|
-
|
264
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
265
|
-
|
266
|
-
### HTTP request headers
|
267
|
-
|
268
|
-
- **Content-Type**: Not defined
|
269
|
-
- **Accept**: application/json
|
270
|
-
|
271
|
-
|
272
142
|
## repo_sync_export
|
273
143
|
|
274
144
|
> RepoSyncEvent repo_sync_export(account_id, id, opts)
|
275
145
|
|
276
146
|
Export to code repository
|
277
147
|
|
278
|
-
|
148
|
+
Export translations from Phrase Strings to repository provider according to the .phrase.yml file within the code repository. *Export is done asynchronously and may take several seconds depending on the project size.*
|
279
149
|
|
280
150
|
### Example
|
281
151
|
|
@@ -338,7 +208,7 @@ Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
|
338
208
|
|
339
209
|
Import from code repository
|
340
210
|
|
341
|
-
|
211
|
+
Import translations from repository provider to Phrase Strings according to the .phrase.yml file within the code repository. _Import is done asynchronously and may take several seconds depending on the project size._
|
342
212
|
|
343
213
|
### Example
|
344
214
|
|
data/docs/Upload.md
CHANGED
@@ -8,7 +8,8 @@ Name | Type | Description | Notes
|
|
8
8
|
**filename** | **String** | | [optional]
|
9
9
|
**format** | **String** | | [optional]
|
10
10
|
**state** | **String** | | [optional]
|
11
|
-
**tag** | **String** | | [optional]
|
11
|
+
**tag** | **String** | Unique tag of the upload | [optional]
|
12
|
+
**tags** | **Array<String>** | List of tags that were assigned to the uploaded keys | [optional]
|
12
13
|
**url** | **String** | The URL to the upload in Phrase Strings app. | [optional]
|
13
14
|
**summary** | [**UploadSummary**](UploadSummary.md) | | [optional]
|
14
15
|
**created_at** | **Time** | | [optional]
|
@@ -24,6 +25,7 @@ instance = Phrase::Upload.new(id: null,
|
|
24
25
|
format: null,
|
25
26
|
state: null,
|
26
27
|
tag: null,
|
28
|
+
tags: null,
|
27
29
|
url: null,
|
28
30
|
summary: null,
|
29
31
|
created_at: null,
|
data/lib/phrase/api/jobs_api.rb
CHANGED
@@ -318,13 +318,12 @@ module Phrase
|
|
318
318
|
# Remove multiple keys from existing job.
|
319
319
|
# @param project_id [String] Project ID
|
320
320
|
# @param id [String] ID
|
321
|
+
# @param job_keys_delete_parameters [JobKeysDeleteParameters]
|
321
322
|
# @param [Hash] opts the optional parameters
|
322
323
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
323
|
-
# @option opts [String] :branch specify the branch to use
|
324
|
-
# @option opts [Array<String>] :translation_key_ids ids of keys that should be removed from the job
|
325
324
|
# @return [nil]
|
326
|
-
def job_keys_delete(project_id, id, opts = {})
|
327
|
-
data, _status_code, _headers = job_keys_delete_with_http_info(project_id, id, opts)
|
325
|
+
def job_keys_delete(project_id, id, job_keys_delete_parameters, opts = {})
|
326
|
+
data, _status_code, _headers = job_keys_delete_with_http_info(project_id, id, job_keys_delete_parameters, opts)
|
328
327
|
data
|
329
328
|
end
|
330
329
|
|
@@ -332,12 +331,11 @@ module Phrase
|
|
332
331
|
# Remove multiple keys from existing job.
|
333
332
|
# @param project_id [String] Project ID
|
334
333
|
# @param id [String] ID
|
334
|
+
# @param job_keys_delete_parameters [JobKeysDeleteParameters]
|
335
335
|
# @param [Hash] opts the optional parameters
|
336
336
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
337
|
-
# @option opts [String] :branch specify the branch to use
|
338
|
-
# @option opts [Array<String>] :translation_key_ids ids of keys that should be removed from the job
|
339
337
|
# @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
|
340
|
-
def job_keys_delete_with_http_info(project_id, id, opts = {})
|
338
|
+
def job_keys_delete_with_http_info(project_id, id, job_keys_delete_parameters, opts = {})
|
341
339
|
if @api_client.config.debugging
|
342
340
|
@api_client.config.logger.debug 'Calling API: JobsApi.job_keys_delete ...'
|
343
341
|
end
|
@@ -349,23 +347,27 @@ module Phrase
|
|
349
347
|
if @api_client.config.client_side_validation && id.nil?
|
350
348
|
fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_keys_delete"
|
351
349
|
end
|
350
|
+
# verify the required parameter 'job_keys_delete_parameters' is set
|
351
|
+
if @api_client.config.client_side_validation && job_keys_delete_parameters.nil?
|
352
|
+
fail ArgumentError, "Missing the required parameter 'job_keys_delete_parameters' when calling JobsApi.job_keys_delete"
|
353
|
+
end
|
352
354
|
# resource path
|
353
355
|
local_var_path = '/projects/{project_id}/jobs/{id}/keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
354
356
|
|
355
357
|
# query parameters
|
356
358
|
query_params = opts[:query_params] || {}
|
357
|
-
query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
|
358
|
-
query_params[:'translation_key_ids'] = @api_client.build_collection_param(opts[:'translation_key_ids'], :multi) if !opts[:'translation_key_ids'].nil?
|
359
359
|
|
360
360
|
# header parameters
|
361
361
|
header_params = opts[:header_params] || {}
|
362
|
+
# HTTP header 'Content-Type'
|
363
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
362
364
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
363
365
|
|
364
366
|
# form parameters
|
365
367
|
form_params = opts[:form_params] || {}
|
366
368
|
|
367
369
|
# http body (model)
|
368
|
-
post_body = opts[:body]
|
370
|
+
post_body = opts[:body] || @api_client.object_to_http_body(job_keys_delete_parameters)
|
369
371
|
|
370
372
|
# return_type
|
371
373
|
return_type = opts[:return_type]
|
@@ -860,7 +862,8 @@ module Phrase
|
|
860
862
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
861
863
|
# @option opts [String] :owned_by filter by user owning job
|
862
864
|
# @option opts [String] :assigned_to filter by user assigned to job
|
863
|
-
# @option opts [String] :state filter by state of job
|
865
|
+
# @option opts [String] :state filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
866
|
+
# @option opts [String] :updated_since filter by jobs updated since given date
|
864
867
|
# @return [Array<Job>]
|
865
868
|
def jobs_by_account(account_id, opts = {})
|
866
869
|
data, _status_code, _headers = jobs_by_account_with_http_info(account_id, opts)
|
@@ -876,7 +879,8 @@ module Phrase
|
|
876
879
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
877
880
|
# @option opts [String] :owned_by filter by user owning job
|
878
881
|
# @option opts [String] :assigned_to filter by user assigned to job
|
879
|
-
# @option opts [String] :state filter by state of job
|
882
|
+
# @option opts [String] :state filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
883
|
+
# @option opts [String] :updated_since filter by jobs updated since given date
|
880
884
|
# @return [Array<(Response<(Array<Job>)>, Integer, Hash)>] Response<(Array<Job>)> data, response status code and response headers
|
881
885
|
def jobs_by_account_with_http_info(account_id, opts = {})
|
882
886
|
if @api_client.config.debugging
|
@@ -896,6 +900,7 @@ module Phrase
|
|
896
900
|
query_params[:'owned_by'] = opts[:'owned_by'] if !opts[:'owned_by'].nil?
|
897
901
|
query_params[:'assigned_to'] = opts[:'assigned_to'] if !opts[:'assigned_to'].nil?
|
898
902
|
query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
|
903
|
+
query_params[:'updated_since'] = opts[:'updated_since'] if !opts[:'updated_since'].nil?
|
899
904
|
|
900
905
|
# header parameters
|
901
906
|
header_params = opts[:header_params] || {}
|
@@ -939,10 +944,11 @@ module Phrase
|
|
939
944
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
940
945
|
# @option opts [Integer] :page Page number
|
941
946
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
942
|
-
# @option opts [String] :branch
|
947
|
+
# @option opts [String] :branch Branch to use
|
943
948
|
# @option opts [String] :owned_by filter by user owning job
|
944
949
|
# @option opts [String] :assigned_to filter by user assigned to job
|
945
|
-
# @option opts [String] :state filter by state of job
|
950
|
+
# @option opts [String] :state filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
951
|
+
# @option opts [String] :updated_since filter by jobs updated since given date
|
946
952
|
# @return [Array<Job>]
|
947
953
|
def jobs_list(project_id, opts = {})
|
948
954
|
data, _status_code, _headers = jobs_list_with_http_info(project_id, opts)
|
@@ -956,10 +962,11 @@ module Phrase
|
|
956
962
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
957
963
|
# @option opts [Integer] :page Page number
|
958
964
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
959
|
-
# @option opts [String] :branch
|
965
|
+
# @option opts [String] :branch Branch to use
|
960
966
|
# @option opts [String] :owned_by filter by user owning job
|
961
967
|
# @option opts [String] :assigned_to filter by user assigned to job
|
962
|
-
# @option opts [String] :state filter by state of job
|
968
|
+
# @option opts [String] :state filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
969
|
+
# @option opts [String] :updated_since filter by jobs updated since given date
|
963
970
|
# @return [Array<(Response<(Array<Job>)>, Integer, Hash)>] Response<(Array<Job>)> data, response status code and response headers
|
964
971
|
def jobs_list_with_http_info(project_id, opts = {})
|
965
972
|
if @api_client.config.debugging
|
@@ -980,6 +987,7 @@ module Phrase
|
|
980
987
|
query_params[:'owned_by'] = opts[:'owned_by'] if !opts[:'owned_by'].nil?
|
981
988
|
query_params[:'assigned_to'] = opts[:'assigned_to'] if !opts[:'assigned_to'].nil?
|
982
989
|
query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
|
990
|
+
query_params[:'updated_since'] = opts[:'updated_since'] if !opts[:'updated_since'].nil?
|
983
991
|
|
984
992
|
# header parameters
|
985
993
|
header_params = opts[:header_params] || {}
|