phrase 2.3.0 → 2.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -3
- data/docs/Distribution.md +2 -0
- data/docs/DistributionCreateParameters.md +2 -0
- data/docs/DistributionUpdateParameters.md +2 -0
- data/docs/ICUApi.md +70 -0
- data/docs/Icu.md +17 -0
- data/docs/IcuSkeletonParameters.md +21 -0
- data/docs/Invitation.md +2 -0
- data/docs/InvitationCreateParameters.md +2 -0
- data/docs/InvitationUpdateParameters.md +2 -0
- data/docs/JobLocaleCompleteReviewParameters.md +17 -0
- data/docs/JobLocaleUpdateParameters.md +3 -1
- data/docs/JobLocalesApi.md +68 -0
- data/docs/JobLocalesCreateParameters.md +4 -2
- data/docs/Member.md +6 -0
- data/docs/Project.md +2 -0
- data/docs/ProjectDetails.md +2 -0
- data/docs/ProjectLocales.md +2 -0
- data/docs/ProjectMemberSpecific.md +27 -0
- data/docs/ReleaseCreateParameters.md +2 -0
- data/docs/Team1.md +23 -0
- data/docs/TranslationsVerifyParameters.md +3 -5
- data/docs/UserPreview.md +3 -1
- data/lib/phrase/api/icu_api.rb +78 -0
- data/lib/phrase/api/job_locales_api.rb +86 -0
- data/lib/phrase/models/distribution.rb +12 -1
- data/lib/phrase/models/distribution_create_parameters.rb +13 -1
- data/lib/phrase/models/distribution_update_parameters.rb +13 -1
- data/lib/phrase/models/icu.rb +195 -0
- data/lib/phrase/models/icu_skeleton_parameters.rb +217 -0
- data/lib/phrase/models/invitation.rb +12 -1
- data/lib/phrase/models/invitation_create_parameters.rb +13 -1
- data/lib/phrase/models/invitation_update_parameters.rb +13 -1
- data/lib/phrase/models/job_locale_complete_review_parameters.rb +195 -0
- data/lib/phrase/models/job_locale_update_parameters.rb +16 -4
- data/lib/phrase/models/job_locales_create_parameters.rb +17 -5
- data/lib/phrase/models/member.rb +30 -1
- data/lib/phrase/models/project.rb +10 -1
- data/lib/phrase/models/project_details.rb +10 -1
- data/lib/phrase/models/project_locales.rb +11 -2
- data/lib/phrase/models/project_member_specific.rb +239 -0
- data/lib/phrase/models/release_create_parameters.rb +13 -1
- data/lib/phrase/models/team1.rb +221 -0
- data/lib/phrase/models/translations_verify_parameters.rb +14 -24
- data/lib/phrase/models/user_preview.rb +13 -4
- data/lib/phrase/response.rb +1 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +6 -0
- data/phrase.gemspec +2 -2
- data/spec/api/icu_api_spec.rb +36 -0
- data/spec/api/job_locales_api_spec.rb +16 -0
- data/spec/models/distribution_create_parameters_spec.rb +6 -0
- data/spec/models/distribution_spec.rb +6 -0
- data/spec/models/distribution_update_parameters_spec.rb +6 -0
- data/spec/models/icu_skeleton_parameters_spec.rb +41 -0
- data/spec/models/icu_spec.rb +29 -0
- data/spec/models/invitation_create_parameters_spec.rb +6 -0
- data/spec/models/invitation_spec.rb +6 -0
- data/spec/models/invitation_update_parameters_spec.rb +6 -0
- data/spec/models/job_locale_complete_review_parameters_spec.rb +29 -0
- data/spec/models/job_locale_update_parameters_spec.rb +6 -0
- data/spec/models/job_locales_create_parameters_spec.rb +6 -0
- data/spec/models/member_spec.rb +18 -0
- data/spec/models/project_details_spec.rb +6 -0
- data/spec/models/project_locales_spec.rb +6 -0
- data/spec/models/project_member_specific_spec.rb +59 -0
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/release_create_parameters_spec.rb +6 -0
- data/spec/models/team1_spec.rb +47 -0
- data/spec/models/translations_verify_parameters_spec.rb +2 -8
- data/spec/models/user_preview_spec.rb +6 -0
- metadata +218 -194
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b7172a74587dd0cc07e91bee98a1704f41a00a5cba1a67e188783fbeddad171b
|
4
|
+
data.tar.gz: 75236174eeb3cd53ac3f0680195f3f3551f35d89251a9275a52a95e6ce827f6b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ff69aa4ad7f154d6bae216853b86df2f731fdddaa27fac44512e0ca0f39a4fca7af4539e59d61f2aa5e2ba2d96221411531f0d83348c63c0e0d8e49e69625f9c
|
7
|
+
data.tar.gz: 955a37c3fd96b6eb05edf01bdff0bd803d102a93b5cb7387dd12cbcc1a7e3d57776b07d8c038299fa1c216e4b0c86601689b2ad45ca383967f314d9a331fb474
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
|
|
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.5.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
|
13
13
|
|
@@ -56,10 +56,10 @@ gem build phrase.gemspec
|
|
56
56
|
Then install the gem locally:
|
57
57
|
|
58
58
|
```shell
|
59
|
-
gem install ./phrase-2.
|
59
|
+
gem install ./phrase-2.5.1.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.
|
62
|
+
(for development, run `gem install --dev ./phrase-2.5.1.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -98,6 +98,10 @@ end
|
|
98
98
|
|
99
99
|
```
|
100
100
|
|
101
|
+
## Get help / support
|
102
|
+
|
103
|
+
Please contact [support@phrase.com](mailto:support@phrase.com?subject=[GitHub]%20phrase-go) and we can take more direct action toward finding a solution.
|
104
|
+
|
101
105
|
## Documentation for API Endpoints
|
102
106
|
|
103
107
|
All URIs are relative to *https://api.phrase.com/v2*
|
@@ -164,6 +168,7 @@ Class | Method | HTTP request | Description
|
|
164
168
|
*Phrase::GlossaryTermsApi* | [**glossary_term_show**](docs/GlossaryTermsApi.md#glossary_term_show) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Get a single glossary term
|
165
169
|
*Phrase::GlossaryTermsApi* | [**glossary_term_update**](docs/GlossaryTermsApi.md#glossary_term_update) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Update a glossary term
|
166
170
|
*Phrase::GlossaryTermsApi* | [**glossary_terms_list**](docs/GlossaryTermsApi.md#glossary_terms_list) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms | List glossary terms
|
171
|
+
*Phrase::ICUApi* | [**icu_skeleton**](docs/ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build icu skeletons
|
167
172
|
*Phrase::InvitationsApi* | [**invitation_create**](docs/InvitationsApi.md#invitation_create) | **POST** /accounts/{account_id}/invitations | Create a new invitation
|
168
173
|
*Phrase::InvitationsApi* | [**invitation_delete**](docs/InvitationsApi.md#invitation_delete) | **DELETE** /accounts/{account_id}/invitations/{id} | Delete an invitation
|
169
174
|
*Phrase::InvitationsApi* | [**invitation_resend**](docs/InvitationsApi.md#invitation_resend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
|
@@ -172,6 +177,7 @@ Class | Method | HTTP request | Description
|
|
172
177
|
*Phrase::InvitationsApi* | [**invitation_update_settings**](docs/InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
|
173
178
|
*Phrase::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
|
174
179
|
*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
|
180
|
+
*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
|
175
181
|
*Phrase::JobLocalesApi* | [**job_locale_delete**](docs/JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Delete a job locale
|
176
182
|
*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
|
177
183
|
*Phrase::JobLocalesApi* | [**job_locale_show**](docs/JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locale/{id} | Get a single job locale
|
@@ -371,6 +377,8 @@ Class | Method | HTTP request | Description
|
|
371
377
|
- [Phrase::GlossaryTermTranslationUpdateParameters](docs/GlossaryTermTranslationUpdateParameters.md)
|
372
378
|
- [Phrase::GlossaryTermUpdateParameters](docs/GlossaryTermUpdateParameters.md)
|
373
379
|
- [Phrase::GlossaryUpdateParameters](docs/GlossaryUpdateParameters.md)
|
380
|
+
- [Phrase::Icu](docs/Icu.md)
|
381
|
+
- [Phrase::IcuSkeletonParameters](docs/IcuSkeletonParameters.md)
|
374
382
|
- [Phrase::InlineResponse422](docs/InlineResponse422.md)
|
375
383
|
- [Phrase::InlineResponse422Errors](docs/InlineResponse422Errors.md)
|
376
384
|
- [Phrase::Invitation](docs/Invitation.md)
|
@@ -385,6 +393,7 @@ Class | Method | HTTP request | Description
|
|
385
393
|
- [Phrase::JobKeysCreateParameters](docs/JobKeysCreateParameters.md)
|
386
394
|
- [Phrase::JobLocale](docs/JobLocale.md)
|
387
395
|
- [Phrase::JobLocaleCompleteParameters](docs/JobLocaleCompleteParameters.md)
|
396
|
+
- [Phrase::JobLocaleCompleteReviewParameters](docs/JobLocaleCompleteReviewParameters.md)
|
388
397
|
- [Phrase::JobLocaleReopenParameters](docs/JobLocaleReopenParameters.md)
|
389
398
|
- [Phrase::JobLocaleUpdateParameters](docs/JobLocaleUpdateParameters.md)
|
390
399
|
- [Phrase::JobLocalesCreateParameters](docs/JobLocalesCreateParameters.md)
|
@@ -433,6 +442,7 @@ Class | Method | HTTP request | Description
|
|
433
442
|
- [Phrase::ProjectDetails1](docs/ProjectDetails1.md)
|
434
443
|
- [Phrase::ProjectLocales](docs/ProjectLocales.md)
|
435
444
|
- [Phrase::ProjectLocales1](docs/ProjectLocales1.md)
|
445
|
+
- [Phrase::ProjectMemberSpecific](docs/ProjectMemberSpecific.md)
|
436
446
|
- [Phrase::ProjectShort](docs/ProjectShort.md)
|
437
447
|
- [Phrase::ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
|
438
448
|
- [Phrase::Release](docs/Release.md)
|
@@ -465,6 +475,7 @@ Class | Method | HTTP request | Description
|
|
465
475
|
- [Phrase::TagWithStats1Statistics](docs/TagWithStats1Statistics.md)
|
466
476
|
- [Phrase::TagWithStats1Statistics1](docs/TagWithStats1Statistics1.md)
|
467
477
|
- [Phrase::Team](docs/Team.md)
|
478
|
+
- [Phrase::Team1](docs/Team1.md)
|
468
479
|
- [Phrase::TeamCreateParameters](docs/TeamCreateParameters.md)
|
469
480
|
- [Phrase::TeamDetail](docs/TeamDetail.md)
|
470
481
|
- [Phrase::TeamUpdateParameters](docs/TeamUpdateParameters.md)
|
data/docs/Distribution.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**name** | **String** | | [optional]
|
9
9
|
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
10
10
|
**platforms** | **Array<String>** | | [optional]
|
11
|
+
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
11
12
|
**releases** | [**Array<ReleasePreview>**](ReleasePreview.md) | | [optional]
|
12
13
|
**created_at** | **DateTime** | | [optional]
|
13
14
|
**deleted_at** | **DateTime** | | [optional]
|
@@ -21,6 +22,7 @@ instance = Phrase::Distribution.new(id: null,
|
|
21
22
|
name: null,
|
22
23
|
project: null,
|
23
24
|
platforms: null,
|
25
|
+
locales: null,
|
24
26
|
releases: null,
|
25
27
|
created_at: null,
|
26
28
|
deleted_at: null)
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the distribution | [optional]
|
8
8
|
**project_id** | **String** | Project id the distribution should be assigned to. | [optional]
|
9
9
|
**platforms** | **Array<String>** | List of platforms the distribution should support. | [optional]
|
10
|
+
**locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional]
|
10
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]
|
11
12
|
**fallback_to_non_regional_locale** | **Boolean** | Indicates whether to fallback to non regional locale when locale can not be found | [optional]
|
12
13
|
**fallback_to_default_locale** | **Boolean** | Indicates whether to fallback to projects default locale when locale can not be found | [optional]
|
@@ -20,6 +21,7 @@ require 'Phrase'
|
|
20
21
|
instance = Phrase::DistributionCreateParameters.new(name: My Android Distribution,
|
21
22
|
project_id: abcd1234abcd1234abcd1234,
|
22
23
|
platforms: ["android","ios"],
|
24
|
+
locale_ids: ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],
|
23
25
|
format_options: {xml:{enclose_in_cdata:'1'}},
|
24
26
|
fallback_to_non_regional_locale: true,
|
25
27
|
fallback_to_default_locale: true,
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the distribution | [optional]
|
8
8
|
**project_id** | **String** | Project id the distribution should be assigned to. | [optional]
|
9
9
|
**platforms** | **Array<String>** | List of platforms the distribution should support. | [optional]
|
10
|
+
**locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional]
|
10
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]
|
11
12
|
**fallback_to_non_regional_locale** | **Boolean** | Indicates whether to fallback to non regional locale when locale can not be found | [optional]
|
12
13
|
**fallback_to_default_locale** | **Boolean** | Indicates whether to fallback to projects default locale when locale can not be found | [optional]
|
@@ -20,6 +21,7 @@ require 'Phrase'
|
|
20
21
|
instance = Phrase::DistributionUpdateParameters.new(name: My Android Distribution,
|
21
22
|
project_id: abcd1234abcd1234abcd1234,
|
22
23
|
platforms: ["android","ios"],
|
24
|
+
locale_ids: ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],
|
23
25
|
format_options: {xml:{enclose_in_cdata:'1'}},
|
24
26
|
fallback_to_non_regional_locale: true,
|
25
27
|
fallback_to_default_locale: true,
|
data/docs/ICUApi.md
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
# Phrase::ICUApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**icu_skeleton**](ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build icu skeletons
|
8
|
+
|
9
|
+
|
10
|
+
|
11
|
+
## icu_skeleton
|
12
|
+
|
13
|
+
> Icu icu_skeleton(icu_skeleton_parameters, opts)
|
14
|
+
|
15
|
+
Build icu skeletons
|
16
|
+
|
17
|
+
Returns icu skeletons for multiple locale codes based on a source content.
|
18
|
+
|
19
|
+
### Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'phrase'
|
24
|
+
# setup authorization
|
25
|
+
Phrase.configure do |config|
|
26
|
+
# Configure HTTP basic authorization: Basic
|
27
|
+
config.username = 'YOUR USERNAME'
|
28
|
+
config.password = 'YOUR PASSWORD'
|
29
|
+
|
30
|
+
# Configure API key authorization: Token
|
31
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
32
|
+
config.api_key_prefix['Authorization'] = 'token'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = Phrase::ICUApi.new
|
36
|
+
icu_skeleton_parameters = Phrase::IcuSkeletonParameters.new # IcuSkeletonParameters |
|
37
|
+
opts = {
|
38
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
#Build icu skeletons
|
43
|
+
result = api_instance.icu_skeleton(icu_skeleton_parameters, opts)
|
44
|
+
pp result
|
45
|
+
rescue Phrase::ApiError => e
|
46
|
+
puts "Exception when calling ICUApi->icu_skeleton: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
### Parameters
|
51
|
+
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**icu_skeleton_parameters** | [**IcuSkeletonParameters**](IcuSkeletonParameters.md)| |
|
56
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
Response<([**Icu**](Icu.md))>
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: application/json
|
69
|
+
- **Accept**: application/json
|
70
|
+
|
data/docs/Icu.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Phrase::Icu
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**locale_code** | **String** | Object keys are dynamic and based on requested locale codes, see example. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'Phrase'
|
13
|
+
|
14
|
+
instance = Phrase::Icu.new(locale_code: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Phrase::IcuSkeletonParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**content** | **String** | Source content | [optional]
|
8
|
+
**locale_codes** | **Array<String>** | Locale codes | [optional]
|
9
|
+
**zero_form_enabled** | **Boolean** | Indicates whether the zero form should be included or excluded in the returned skeletons | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'Phrase'
|
15
|
+
|
16
|
+
instance = Phrase::IcuSkeletonParameters.new(content: {number, plural, one {One} other {%{n}}},
|
17
|
+
locale_codes: ["en"],
|
18
|
+
zero_form_enabled: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/Invitation.md
CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
17
17
|
**updated_at** | **DateTime** | | [optional]
|
18
18
|
**accepted_at** | **DateTime** | | [optional]
|
19
19
|
**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) | | [optional]
|
20
|
+
**teams** | [**Array<Items>**](Items.md) | | [optional]
|
20
21
|
**project_role** | [**Array<MemberProjectDetailProjectRoles>**](MemberProjectDetailProjectRoles.md) | | [optional]
|
21
22
|
|
22
23
|
## Code Sample
|
@@ -37,6 +38,7 @@ instance = Phrase::Invitation.new(id: null,
|
|
37
38
|
updated_at: null,
|
38
39
|
accepted_at: null,
|
39
40
|
spaces: null,
|
41
|
+
teams: null,
|
40
42
|
project_role: null)
|
41
43
|
```
|
42
44
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**project_ids** | **String** | List of project ids the invited user has access to. | [optional]
|
10
10
|
**locale_ids** | **String** | List of locale ids the invited user has access to. | [optional]
|
11
11
|
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
12
|
+
**team_ids** | **Array<String>** | List of teams the user is assigned to. | [optional]
|
12
13
|
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
13
14
|
**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional]
|
14
15
|
|
@@ -22,6 +23,7 @@ instance = Phrase::InvitationCreateParameters.new(email: example@mail.com,
|
|
22
23
|
project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
23
24
|
locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
24
25
|
space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
26
|
+
team_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
25
27
|
default_locale_codes: ["en","de"],
|
26
28
|
permissions: {"create_upload":true,"review_translations":true})
|
27
29
|
```
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**project_ids** | **String** | List of project ids the invited user has access to | [optional]
|
9
9
|
**locale_ids** | **String** | List of locale ids the invited user has access to | [optional]
|
10
10
|
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
11
|
+
**team_ids** | **Array<String>** | List of teams the user is assigned to. | [optional]
|
11
12
|
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
12
13
|
**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. | [optional]
|
13
14
|
|
@@ -20,6 +21,7 @@ instance = Phrase::InvitationUpdateParameters.new(role: Invitiation role,
|
|
20
21
|
project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
21
22
|
locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
22
23
|
space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
24
|
+
team_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
23
25
|
default_locale_codes: ["en","de"],
|
24
26
|
permissions: {"create_upload":true})
|
25
27
|
```
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Phrase::JobLocaleCompleteReviewParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'Phrase'
|
13
|
+
|
14
|
+
instance = Phrase::JobLocaleCompleteReviewParameters.new(branch: my-feature-branch)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
8
|
**locale_id** | **String** | locale id | [optional]
|
9
9
|
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale | [optional]
|
10
|
+
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
12
13
|
|
@@ -15,7 +16,8 @@ require 'Phrase'
|
|
15
16
|
|
16
17
|
instance = Phrase::JobLocaleUpdateParameters.new(branch: my-feature-branch,
|
17
18
|
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
18
|
-
user_ids: ["abcd1234cdef1234abcd1234cdef1234"]
|
19
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
20
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
19
21
|
```
|
20
22
|
|
21
23
|
|
data/docs/JobLocalesApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.phrase.com/v2*
|
|
5
5
|
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
|
+
[**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
|
8
9
|
[**job_locale_delete**](JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Delete a job locale
|
9
10
|
[**job_locale_reopen**](JobLocalesApi.md#job_locale_reopen) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen | Reopen a job locale
|
10
11
|
[**job_locale_show**](JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locale/{id} | Get a single job locale
|
@@ -81,6 +82,73 @@ Response<([**JobLocale**](JobLocale.md))>
|
|
81
82
|
- **Accept**: application/json
|
82
83
|
|
83
84
|
|
85
|
+
## job_locale_complete_review
|
86
|
+
|
87
|
+
> JobLocale job_locale_complete_review(project_id, job_id, id, job_locale_complete_review_parameters, opts)
|
88
|
+
|
89
|
+
Review a job locale
|
90
|
+
|
91
|
+
Mark job locale as reviewed.
|
92
|
+
|
93
|
+
### Example
|
94
|
+
|
95
|
+
```ruby
|
96
|
+
# load the gem
|
97
|
+
require 'phrase'
|
98
|
+
# setup authorization
|
99
|
+
Phrase.configure do |config|
|
100
|
+
# Configure HTTP basic authorization: Basic
|
101
|
+
config.username = 'YOUR USERNAME'
|
102
|
+
config.password = 'YOUR PASSWORD'
|
103
|
+
|
104
|
+
# Configure API key authorization: Token
|
105
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
106
|
+
config.api_key_prefix['Authorization'] = 'token'
|
107
|
+
end
|
108
|
+
|
109
|
+
api_instance = Phrase::JobLocalesApi.new
|
110
|
+
project_id = 'project_id_example' # String | Project ID
|
111
|
+
job_id = 'job_id_example' # String | Job ID
|
112
|
+
id = 'id_example' # String | ID
|
113
|
+
job_locale_complete_review_parameters = Phrase::JobLocaleCompleteReviewParameters.new # JobLocaleCompleteReviewParameters |
|
114
|
+
opts = {
|
115
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
116
|
+
}
|
117
|
+
|
118
|
+
begin
|
119
|
+
#Review a job locale
|
120
|
+
result = api_instance.job_locale_complete_review(project_id, job_id, id, job_locale_complete_review_parameters, opts)
|
121
|
+
pp result
|
122
|
+
rescue Phrase::ApiError => e
|
123
|
+
puts "Exception when calling JobLocalesApi->job_locale_complete_review: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
|
130
|
+
Name | Type | Description | Notes
|
131
|
+
------------- | ------------- | ------------- | -------------
|
132
|
+
**project_id** | **String**| Project ID |
|
133
|
+
**job_id** | **String**| Job ID |
|
134
|
+
**id** | **String**| ID |
|
135
|
+
**job_locale_complete_review_parameters** | [**JobLocaleCompleteReviewParameters**](JobLocaleCompleteReviewParameters.md)| |
|
136
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
137
|
+
|
138
|
+
### Return type
|
139
|
+
|
140
|
+
Response<([**JobLocale**](JobLocale.md))>
|
141
|
+
|
142
|
+
### Authorization
|
143
|
+
|
144
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
145
|
+
|
146
|
+
### HTTP request headers
|
147
|
+
|
148
|
+
- **Content-Type**: application/json
|
149
|
+
- **Accept**: application/json
|
150
|
+
|
151
|
+
|
84
152
|
## job_locale_delete
|
85
153
|
|
86
154
|
> job_locale_delete(project_id, job_id, id, opts)
|
@@ -6,7 +6,8 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
8
|
**locale_id** | **String** | locale id | [optional]
|
9
|
-
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale | [optional]
|
9
|
+
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale as translators | [optional]
|
10
|
+
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
12
13
|
|
@@ -15,7 +16,8 @@ require 'Phrase'
|
|
15
16
|
|
16
17
|
instance = Phrase::JobLocalesCreateParameters.new(branch: my-feature-branch,
|
17
18
|
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
18
|
-
user_ids: ["abcd1234cdef1234abcd1234cdef1234"]
|
19
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
20
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
19
21
|
```
|
20
22
|
|
21
23
|
|
data/docs/Member.md
CHANGED
@@ -7,10 +7,13 @@ Name | Type | Description | Notes
|
|
7
7
|
**id** | **String** | | [optional]
|
8
8
|
**email** | **String** | | [optional]
|
9
9
|
**username** | **String** | | [optional]
|
10
|
+
**created_at** | **DateTime** | | [optional]
|
11
|
+
**last_activity_at** | **DateTime** | | [optional]
|
10
12
|
**role** | **String** | | [optional]
|
11
13
|
**projects** | [**Array<ProjectLocales>**](ProjectLocales.md) | | [optional]
|
12
14
|
**permissions** | [**Object**](.md) | | [optional]
|
13
15
|
**default_locale_codes** | **Array<String>** | | [optional]
|
16
|
+
**teams** | [**Array<Team1>**](Team1.md) | | [optional]
|
14
17
|
**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) | | [optional]
|
15
18
|
|
16
19
|
## Code Sample
|
@@ -21,10 +24,13 @@ require 'Phrase'
|
|
21
24
|
instance = Phrase::Member.new(id: null,
|
22
25
|
email: null,
|
23
26
|
username: null,
|
27
|
+
created_at: null,
|
28
|
+
last_activity_at: null,
|
24
29
|
role: null,
|
25
30
|
projects: null,
|
26
31
|
permissions: null,
|
27
32
|
default_locale_codes: null,
|
33
|
+
teams: null,
|
28
34
|
spaces: null)
|
29
35
|
```
|
30
36
|
|
data/docs/Project.md
CHANGED
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**project_image_url** | **String** | | [optional]
|
12
12
|
**account** | [**Account**](Account.md) | | [optional]
|
13
13
|
**space** | [**Space1**](Space1.md) | | [optional]
|
14
|
+
**point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
|
14
15
|
**created_at** | **DateTime** | | [optional]
|
15
16
|
**updated_at** | **DateTime** | | [optional]
|
16
17
|
|
@@ -26,6 +27,7 @@ instance = Phrase::Project.new(id: null,
|
|
26
27
|
project_image_url: null,
|
27
28
|
account: null,
|
28
29
|
space: null,
|
30
|
+
point_of_contact: null,
|
29
31
|
created_at: null,
|
30
32
|
updated_at: null)
|
31
33
|
```
|
data/docs/ProjectDetails.md
CHANGED
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**project_image_url** | **String** | | [optional]
|
12
12
|
**account** | [**Account**](Account.md) | | [optional]
|
13
13
|
**space** | [**Space1**](Space1.md) | | [optional]
|
14
|
+
**point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
|
14
15
|
**created_at** | **DateTime** | | [optional]
|
15
16
|
**updated_at** | **DateTime** | | [optional]
|
16
17
|
**shares_translation_memory** | **Boolean** | | [optional]
|
@@ -27,6 +28,7 @@ instance = Phrase::ProjectDetails.new(id: null,
|
|
27
28
|
project_image_url: null,
|
28
29
|
account: null,
|
29
30
|
space: null,
|
31
|
+
point_of_contact: null,
|
30
32
|
created_at: null,
|
31
33
|
updated_at: null,
|
32
34
|
shares_translation_memory: null)
|
data/docs/ProjectLocales.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**id** | **String** | | [optional]
|
8
8
|
**name** | **String** | | [optional]
|
9
|
+
**project_role** | **String** | | [optional]
|
9
10
|
**main_format** | **String** | | [optional]
|
10
11
|
**created_at** | **DateTime** | | [optional]
|
11
12
|
**updated_at** | **DateTime** | | [optional]
|
@@ -18,6 +19,7 @@ require 'Phrase'
|
|
18
19
|
|
19
20
|
instance = Phrase::ProjectLocales.new(id: null,
|
20
21
|
name: null,
|
22
|
+
project_role: null,
|
21
23
|
main_format: null,
|
22
24
|
created_at: null,
|
23
25
|
updated_at: null,
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Phrase::ProjectMemberSpecific
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**project_role** | **String** | | [optional]
|
10
|
+
**main_format** | **String** | | [optional]
|
11
|
+
**created_at** | **DateTime** | | [optional]
|
12
|
+
**updated_at** | **DateTime** | | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Phrase'
|
18
|
+
|
19
|
+
instance = Phrase::ProjectMemberSpecific.new(id: null,
|
20
|
+
name: null,
|
21
|
+
project_role: null,
|
22
|
+
main_format: null,
|
23
|
+
created_at: null,
|
24
|
+
updated_at: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**description** | **String** | Description of the release | [optional]
|
8
8
|
**platforms** | **Array<String>** | List of platforms the release should support. | [optional]
|
9
|
+
**locale_ids** | **Array<String>** | List of locale ids that will be included in the release. If empty, distribution locales will be used | [optional]
|
9
10
|
**branch** | **String** | Branch used for release | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
@@ -15,6 +16,7 @@ require 'Phrase'
|
|
15
16
|
|
16
17
|
instance = Phrase::ReleaseCreateParameters.new(description: My first Release,
|
17
18
|
platforms: ["android","ios"],
|
19
|
+
locale_ids: ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],
|
18
20
|
branch: my-feature-branch)
|
19
21
|
```
|
20
22
|
|
data/docs/Team1.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# Phrase::Team1
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**created_at** | **DateTime** | | [optional]
|
10
|
+
**updated_at** | **DateTime** | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'Phrase'
|
16
|
+
|
17
|
+
instance = Phrase::Team1.new(id: null,
|
18
|
+
name: null,
|
19
|
+
created_at: null,
|
20
|
+
updated_at: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -5,9 +5,8 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
+
**locale_id** | **String** | specify the locale of the translations to be verified | [optional]
|
8
9
|
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
9
|
-
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
10
|
-
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
11
10
|
|
12
11
|
## Code Sample
|
13
12
|
|
@@ -15,9 +14,8 @@ Name | Type | Description | Notes
|
|
15
14
|
require 'Phrase'
|
16
15
|
|
17
16
|
instance = Phrase::TranslationsVerifyParameters.new(branch: my-feature-branch,
|
18
|
-
|
19
|
-
|
20
|
-
order: desc)
|
17
|
+
locale_id: fc2f11dd6a658fa9652f6f0a9ebee688,
|
18
|
+
q: PhraseApp*%20unverified:true%20tags:feature,center)
|
21
19
|
```
|
22
20
|
|
23
21
|
|
data/docs/UserPreview.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**id** | **String** | | [optional]
|
8
8
|
**username** | **String** | | [optional]
|
9
9
|
**name** | **String** | | [optional]
|
10
|
+
**gravatar_uid** | **String** | | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
12
13
|
|
@@ -15,7 +16,8 @@ require 'Phrase'
|
|
15
16
|
|
16
17
|
instance = Phrase::UserPreview.new(id: null,
|
17
18
|
username: null,
|
18
|
-
name: null
|
19
|
+
name: null,
|
20
|
+
gravatar_uid: null)
|
19
21
|
```
|
20
22
|
|
21
23
|
|