phrase 1.0.10 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +25 -9
- data/docs/CurrentUser.md +31 -0
- data/docs/Invitation.md +9 -1
- data/docs/InvitationCreateParameters.md +4 -0
- data/docs/InvitationUpdateParameters.md +4 -0
- data/docs/InvitationUpdateSettingsParameters.md +19 -0
- data/docs/InvitationsApi.md +66 -0
- data/docs/JobLocale.md +5 -1
- data/docs/KeysApi.md +5 -5
- data/docs/LocalesApi.md +5 -4
- data/docs/Member.md +7 -1
- data/docs/MemberProjectDetail.md +35 -0
- data/docs/MemberProjectDetailProjectRoles.md +19 -0
- data/docs/MemberSpaces.md +25 -0
- data/docs/MemberUpdateParameters.md +4 -0
- data/docs/MemberUpdateSettingsParameters.md +19 -0
- data/docs/MembersApi.md +66 -0
- data/docs/ProjectUpdateParameters.md +43 -9
- data/docs/ScreenshotCreateParameters.md +3 -1
- data/docs/ScreenshotMarkerCreateParameters.md +3 -1
- data/docs/ScreenshotMarkerUpdateParameters.md +3 -1
- data/docs/ScreenshotMarkersApi.md +9 -3
- data/docs/ScreenshotUpdateParameters.md +3 -1
- data/docs/ScreenshotsApi.md +8 -2
- data/docs/TranslationsApi.md +25 -25
- data/docs/UsersApi.md +2 -2
- data/docs/Variable.md +23 -0
- data/docs/VariableCreateParameters.md +19 -0
- data/docs/VariableUpdateParameters.md +19 -0
- data/docs/VariablesApi.md +331 -0
- data/lib/phrase.rb +10 -0
- data/lib/phrase/api/invitations_api.rb +80 -0
- data/lib/phrase/api/keys_api.rb +6 -6
- data/lib/phrase/api/locales_api.rb +5 -3
- data/lib/phrase/api/members_api.rb +80 -0
- data/lib/phrase/api/screenshot_markers_api.rb +9 -0
- data/lib/phrase/api/screenshots_api.rb +9 -0
- data/lib/phrase/api/translations_api.rb +35 -35
- data/lib/phrase/api/users_api.rb +3 -3
- data/lib/phrase/api/variables_api.rb +378 -0
- data/lib/phrase/models/current_user.rb +257 -0
- data/lib/phrase/models/invitation.rb +48 -4
- data/lib/phrase/models/invitation_create_parameters.rb +25 -1
- data/lib/phrase/models/invitation_update_parameters.rb +25 -1
- data/lib/phrase/models/invitation_update_settings_parameters.rb +207 -0
- data/lib/phrase/models/job_locale.rb +22 -4
- data/lib/phrase/models/member.rb +35 -4
- data/lib/phrase/models/member_project_detail.rb +285 -0
- data/lib/phrase/models/member_project_detail_project_roles.rb +203 -0
- data/lib/phrase/models/member_spaces.rb +230 -0
- data/lib/phrase/models/member_update_parameters.rb +25 -1
- data/lib/phrase/models/member_update_settings_parameters.rb +207 -0
- data/lib/phrase/models/project_update_parameters.rb +183 -13
- data/lib/phrase/models/screenshot_create_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_update_parameters.rb +11 -1
- data/lib/phrase/models/variable.rb +221 -0
- data/lib/phrase/models/variable_create_parameters.rb +205 -0
- data/lib/phrase/models/variable_update_parameters.rb +205 -0
- data/lib/phrase/version.rb +1 -1
- data/spec/api/invitations_api_spec.rb +15 -0
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locales_api_spec.rb +1 -1
- data/spec/api/members_api_spec.rb +15 -0
- data/spec/api/screenshot_markers_api_spec.rb +3 -0
- data/spec/api/screenshots_api_spec.rb +3 -0
- data/spec/api/translations_api_spec.rb +10 -10
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/variables_api_spec.rb +95 -0
- data/spec/models/current_user_spec.rb +71 -0
- data/spec/models/invitation_create_parameters_spec.rb +12 -0
- data/spec/models/invitation_spec.rb +24 -0
- data/spec/models/invitation_update_parameters_spec.rb +12 -0
- data/spec/models/invitation_update_settings_parameters_spec.rb +35 -0
- data/spec/models/job_locale_spec.rb +12 -0
- data/spec/models/member_project_detail_project_roles_spec.rb +35 -0
- data/spec/models/member_project_detail_spec.rb +83 -0
- data/spec/models/member_spaces_spec.rb +53 -0
- data/spec/models/member_spec.rb +18 -0
- data/spec/models/member_update_parameters_spec.rb +12 -0
- data/spec/models/member_update_settings_parameters_spec.rb +35 -0
- data/spec/models/project_update_parameters_spec.rb +103 -1
- data/spec/models/screenshot_create_parameters_spec.rb +6 -0
- data/spec/models/screenshot_marker_create_parameters_spec.rb +6 -0
- data/spec/models/screenshot_marker_update_parameters_spec.rb +6 -0
- data/spec/models/screenshot_update_parameters_spec.rb +6 -0
- data/spec/models/variable_create_parameters_spec.rb +35 -0
- data/spec/models/variable_spec.rb +47 -0
- data/spec/models/variable_update_parameters_spec.rb +35 -0
- metadata +203 -163
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::MemberProjectDetailProjectRoles
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**project_id** | **String** | | [optional]
|
8
|
+
**role** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::MemberProjectDetailProjectRoles.new(project_id: null,
|
16
|
+
role: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Phrase::MemberSpaces
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**created_at** | [**AnyType**](.md) | | [optional]
|
10
|
+
**updated_at** | [**AnyType**](.md) | | [optional]
|
11
|
+
**projects_count** | **Integer** | | [optional]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'Phrase'
|
17
|
+
|
18
|
+
instance = Phrase::MemberSpaces.new(id: null,
|
19
|
+
name: null,
|
20
|
+
created_at: null,
|
21
|
+
updated_at: null,
|
22
|
+
projects_count: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional]
|
8
8
|
**project_ids** | **String** | List of project ids the user has access to. | [optional]
|
9
9
|
**locale_ids** | **String** | List of locale ids the user has access to. | [optional]
|
10
|
+
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
11
|
+
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
10
12
|
**permissions** | **Hash<String, String>** | Additional permissions depending on member role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional]
|
11
13
|
|
12
14
|
## Code Sample
|
@@ -17,6 +19,8 @@ require 'Phrase'
|
|
17
19
|
instance = Phrase::MemberUpdateParameters.new(role: Developer,
|
18
20
|
project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
19
21
|
locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
22
|
+
default_locale_codes: ["en","fi"],
|
23
|
+
space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
20
24
|
permissions: {"create_upload":true,"review_translations":true})
|
21
25
|
```
|
22
26
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::MemberUpdateSettingsParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**project_role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional]
|
8
|
+
**locale_ids** | **Array<String>** | List of locale ids the user has access to. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::MemberUpdateSettingsParameters.new(project_role: Developer,
|
16
|
+
locale_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"])
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/MembersApi.md
CHANGED
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**member_delete**](MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
|
8
8
|
[**member_show**](MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
|
9
9
|
[**member_update**](MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
|
10
|
+
[**member_update_settings**](MembersApi.md#member_update_settings) | **PATCH** /projects/{project_id}/members/{id} | Update a member's project settings
|
10
11
|
[**members_list**](MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
|
11
12
|
|
12
13
|
|
@@ -201,6 +202,71 @@ Response<([**Member**](Member.md))>
|
|
201
202
|
- **Accept**: application/json
|
202
203
|
|
203
204
|
|
205
|
+
## member_update_settings
|
206
|
+
|
207
|
+
> MemberProjectDetail member_update_settings(project_id, id, member_update_settings_parameters, opts)
|
208
|
+
|
209
|
+
Update a member's project settings
|
210
|
+
|
211
|
+
Update user settings in the project. Access token scope must include <code>team.manage</code>.
|
212
|
+
|
213
|
+
### Example
|
214
|
+
|
215
|
+
```ruby
|
216
|
+
# load the gem
|
217
|
+
require 'phrase'
|
218
|
+
# setup authorization
|
219
|
+
Phrase.configure do |config|
|
220
|
+
# Configure HTTP basic authorization: Basic
|
221
|
+
config.username = 'YOUR USERNAME'
|
222
|
+
config.password = 'YOUR PASSWORD'
|
223
|
+
|
224
|
+
# Configure API key authorization: Token
|
225
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
226
|
+
config.api_key_prefix['Authorization'] = 'token'
|
227
|
+
end
|
228
|
+
|
229
|
+
api_instance = Phrase::MembersApi.new
|
230
|
+
project_id = 'project_id_example' # String | Project ID
|
231
|
+
id = 'id_example' # String | ID
|
232
|
+
member_update_settings_parameters = Phrase::MemberUpdateSettingsParameters.new # MemberUpdateSettingsParameters |
|
233
|
+
opts = {
|
234
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
235
|
+
}
|
236
|
+
|
237
|
+
begin
|
238
|
+
#Update a member's project settings
|
239
|
+
result = api_instance.member_update_settings(project_id, id, member_update_settings_parameters, opts)
|
240
|
+
pp result
|
241
|
+
rescue Phrase::ApiError => e
|
242
|
+
puts "Exception when calling MembersApi->member_update_settings: #{e}"
|
243
|
+
end
|
244
|
+
```
|
245
|
+
|
246
|
+
### Parameters
|
247
|
+
|
248
|
+
|
249
|
+
Name | Type | Description | Notes
|
250
|
+
------------- | ------------- | ------------- | -------------
|
251
|
+
**project_id** | **String**| Project ID |
|
252
|
+
**id** | **String**| ID |
|
253
|
+
**member_update_settings_parameters** | [**MemberUpdateSettingsParameters**](MemberUpdateSettingsParameters.md)| |
|
254
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
255
|
+
|
256
|
+
### Return type
|
257
|
+
|
258
|
+
Response<([**MemberProjectDetail**](MemberProjectDetail.md))>
|
259
|
+
|
260
|
+
### Authorization
|
261
|
+
|
262
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
263
|
+
|
264
|
+
### HTTP request headers
|
265
|
+
|
266
|
+
- **Content-Type**: application/json
|
267
|
+
- **Accept**: application/json
|
268
|
+
|
269
|
+
|
204
270
|
## members_list
|
205
271
|
|
206
272
|
> Array<Member> members_list(account_id, opts)
|
@@ -4,24 +4,58 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
7
|
+
**account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional]
|
8
|
+
**name** | **String** | (Optional) Name of the project | [optional]
|
9
|
+
**main_format** | **String** | (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional]
|
10
|
+
**shares_translation_memory** | **Boolean** | (Optional) Indicates whether the project should share the account's translation memory | [optional]
|
11
|
+
**project_image** | **File** | (Optional) Image to identify the project | [optional]
|
12
|
+
**remove_project_image** | **Boolean** | (Optional) Indicates whether the project image should be deleted. | [optional]
|
13
|
+
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://help.phrase.com/help/advanced-review-workflow\">Read more</a> | [optional]
|
14
|
+
**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest | [optional]
|
15
|
+
**enable_branching** | **Boolean** | (Optional) Enable branching in the project | [optional]
|
16
|
+
**protect_master_branch** | **Boolean** | (Optional) Protect the master branch in project where branching is enabled | [optional]
|
17
|
+
**enable_all_data_type_translation_keys_for_translators** | **Boolean** | (Optional) Otherwise, translators are not allowed to edit translations other than strings | [optional]
|
18
|
+
**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages. <a href=\"https://help.phrase.com/help/icu-message-format\">Read more</a> | [optional]
|
19
|
+
**zero_plural_form_enabled** | **Boolean** | (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. | [optional]
|
20
|
+
**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled. <a href=\"https://help.phrase.com/help/autopilot\">Read more</a> | [optional]
|
21
|
+
**autotranslate_check_new_translation_keys** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
22
|
+
**autotranslate_check_new_uploads** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
23
|
+
**autotranslate_check_new_locales** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
24
|
+
**autotranslate_mark_as_unverified** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
25
|
+
**autotranslate_use_machine_translation** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
26
|
+
**autotranslate_use_translation_memory** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
27
|
+
**smart_suggest_enabled** | **Boolean** | (Optional) Smart Suggest, requires machine_translation_enabled | [optional]
|
28
|
+
**smart_suggest_use_glossary** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional]
|
29
|
+
**smart_suggest_use_machine_translation** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional]
|
13
30
|
|
14
31
|
## Code Sample
|
15
32
|
|
16
33
|
```ruby
|
17
34
|
require 'Phrase'
|
18
35
|
|
19
|
-
instance = Phrase::ProjectUpdateParameters.new(
|
36
|
+
instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
|
37
|
+
name: My Android Project,
|
20
38
|
main_format: yml,
|
21
39
|
shares_translation_memory: true,
|
22
40
|
project_image: null,
|
23
|
-
remove_project_image:
|
24
|
-
|
41
|
+
remove_project_image: false,
|
42
|
+
workflow: review,
|
43
|
+
machine_translation_enabled: true,
|
44
|
+
enable_branching: true,
|
45
|
+
protect_master_branch: true,
|
46
|
+
enable_all_data_type_translation_keys_for_translators: true,
|
47
|
+
enable_icu_message_format: true,
|
48
|
+
zero_plural_form_enabled: true,
|
49
|
+
autotranslate_enabled: true,
|
50
|
+
autotranslate_check_new_translation_keys: true,
|
51
|
+
autotranslate_check_new_uploads: true,
|
52
|
+
autotranslate_check_new_locales: true,
|
53
|
+
autotranslate_mark_as_unverified: true,
|
54
|
+
autotranslate_use_machine_translation: true,
|
55
|
+
autotranslate_use_translation_memory: true,
|
56
|
+
smart_suggest_enabled: true,
|
57
|
+
smart_suggest_use_glossary: true,
|
58
|
+
smart_suggest_use_machine_translation: true)
|
25
59
|
```
|
26
60
|
|
27
61
|
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
7
8
|
**name** | **String** | Name of the screenshot | [optional]
|
8
9
|
**description** | **String** | Description of the screenshot | [optional]
|
9
10
|
**filename** | **File** | Screenshot file | [optional]
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
13
14
|
```ruby
|
14
15
|
require 'Phrase'
|
15
16
|
|
16
|
-
instance = Phrase::ScreenshotCreateParameters.new(
|
17
|
+
instance = Phrase::ScreenshotCreateParameters.new(branch: my-feature-branch,
|
18
|
+
name: A screenshot name,
|
17
19
|
description: A screenshot description,
|
18
20
|
filename: null)
|
19
21
|
```
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
7
8
|
**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional]
|
8
9
|
**presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional]
|
9
10
|
|
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
|
|
12
13
|
```ruby
|
13
14
|
require 'Phrase'
|
14
15
|
|
15
|
-
instance = Phrase::ScreenshotMarkerCreateParameters.new(
|
16
|
+
instance = Phrase::ScreenshotMarkerCreateParameters.new(branch: my-feature-branch,
|
17
|
+
key_id: abcd1234abcd1234abcd1234abcd1234,
|
16
18
|
presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
|
17
19
|
```
|
18
20
|
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
7
8
|
**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional]
|
8
9
|
**presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional]
|
9
10
|
|
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
|
|
12
13
|
```ruby
|
13
14
|
require 'Phrase'
|
14
15
|
|
15
|
-
instance = Phrase::ScreenshotMarkerUpdateParameters.new(
|
16
|
+
instance = Phrase::ScreenshotMarkerUpdateParameters.new(branch: my-feature-branch,
|
17
|
+
key_id: abcd1234abcd1234abcd1234abcd1234,
|
16
18
|
presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
|
17
19
|
```
|
18
20
|
|
@@ -105,7 +105,8 @@ api_instance = Phrase::ScreenshotMarkersApi.new
|
|
105
105
|
project_id = 'project_id_example' # String | Project ID
|
106
106
|
screenshot_id = 'screenshot_id_example' # String | Screenshot ID
|
107
107
|
opts = {
|
108
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
108
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
109
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
109
110
|
}
|
110
111
|
|
111
112
|
begin
|
@@ -124,6 +125,7 @@ Name | Type | Description | Notes
|
|
124
125
|
**project_id** | **String**| Project ID |
|
125
126
|
**screenshot_id** | **String**| Screenshot ID |
|
126
127
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
128
|
+
**branch** | **String**| specify the branch to use | [optional]
|
127
129
|
|
128
130
|
### Return type
|
129
131
|
|
@@ -168,7 +170,8 @@ project_id = 'project_id_example' # String | Project ID
|
|
168
170
|
screenshot_id = 'screenshot_id_example' # String | Screenshot ID
|
169
171
|
id = 'id_example' # String | ID
|
170
172
|
opts = {
|
171
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
173
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
174
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
172
175
|
}
|
173
176
|
|
174
177
|
begin
|
@@ -189,6 +192,7 @@ Name | Type | Description | Notes
|
|
189
192
|
**screenshot_id** | **String**| Screenshot ID |
|
190
193
|
**id** | **String**| ID |
|
191
194
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
195
|
+
**branch** | **String**| specify the branch to use | [optional]
|
192
196
|
|
193
197
|
### Return type
|
194
198
|
|
@@ -299,7 +303,8 @@ id = 'id_example' # String | ID
|
|
299
303
|
opts = {
|
300
304
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
301
305
|
page: 1, # Integer | Page number
|
302
|
-
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
306
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
307
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
303
308
|
}
|
304
309
|
|
305
310
|
begin
|
@@ -321,6 +326,7 @@ Name | Type | Description | Notes
|
|
321
326
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
322
327
|
**page** | **Integer**| Page number | [optional]
|
323
328
|
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
329
|
+
**branch** | **String**| specify the branch to use | [optional]
|
324
330
|
|
325
331
|
### Return type
|
326
332
|
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
7
8
|
**name** | **String** | Name of the screenshot | [optional]
|
8
9
|
**description** | **String** | Description of the screenshot | [optional]
|
9
10
|
**filename** | **File** | Screenshot file | [optional]
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
13
14
|
```ruby
|
14
15
|
require 'Phrase'
|
15
16
|
|
16
|
-
instance = Phrase::ScreenshotUpdateParameters.new(
|
17
|
+
instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
|
18
|
+
name: A screenshot name,
|
17
19
|
description: A screenshot description,
|
18
20
|
filename: null)
|
19
21
|
```
|
data/docs/ScreenshotsApi.md
CHANGED
@@ -103,7 +103,8 @@ api_instance = Phrase::ScreenshotsApi.new
|
|
103
103
|
project_id = 'project_id_example' # String | Project ID
|
104
104
|
id = 'id_example' # String | ID
|
105
105
|
opts = {
|
106
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
106
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
107
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
107
108
|
}
|
108
109
|
|
109
110
|
begin
|
@@ -122,6 +123,7 @@ Name | Type | Description | Notes
|
|
122
123
|
**project_id** | **String**| Project ID |
|
123
124
|
**id** | **String**| ID |
|
124
125
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
126
|
+
**branch** | **String**| specify the branch to use | [optional]
|
125
127
|
|
126
128
|
### Return type
|
127
129
|
|
@@ -165,7 +167,8 @@ api_instance = Phrase::ScreenshotsApi.new
|
|
165
167
|
project_id = 'project_id_example' # String | Project ID
|
166
168
|
id = 'id_example' # String | ID
|
167
169
|
opts = {
|
168
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
170
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
171
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
169
172
|
}
|
170
173
|
|
171
174
|
begin
|
@@ -185,6 +188,7 @@ Name | Type | Description | Notes
|
|
185
188
|
**project_id** | **String**| Project ID |
|
186
189
|
**id** | **String**| ID |
|
187
190
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
191
|
+
**branch** | **String**| specify the branch to use | [optional]
|
188
192
|
|
189
193
|
### Return type
|
190
194
|
|
@@ -295,6 +299,7 @@ opts = {
|
|
295
299
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
296
300
|
page: 1, # Integer | Page number
|
297
301
|
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
302
|
+
branch: 'my-feature-branch', # String | specify the branch to use
|
298
303
|
key_id: 'abcd1234cdef1234abcd1234cdef1234' # String | filter by key
|
299
304
|
}
|
300
305
|
|
@@ -316,6 +321,7 @@ Name | Type | Description | Notes
|
|
316
321
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
317
322
|
**page** | **Integer**| Page number | [optional]
|
318
323
|
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
324
|
+
**branch** | **String**| specify the branch to use | [optional]
|
319
325
|
**key_id** | **String**| filter by key | [optional]
|
320
326
|
|
321
327
|
### Return type
|
data/docs/TranslationsApi.md
CHANGED
@@ -14,13 +14,13 @@ Method | HTTP request | Description
|
|
14
14
|
[**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
|
15
15
|
[**translations_by_key**](TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
|
16
16
|
[**translations_by_locale**](TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
|
17
|
-
[**
|
18
|
-
[**
|
17
|
+
[**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
|
18
|
+
[**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
|
19
19
|
[**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
|
20
|
-
[**
|
20
|
+
[**translations_review_collection**](TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
|
21
21
|
[**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
|
22
|
-
[**
|
23
|
-
[**
|
22
|
+
[**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
|
23
|
+
[**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
|
24
24
|
|
25
25
|
|
26
26
|
|
@@ -692,9 +692,9 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
692
692
|
- **Accept**: application/json
|
693
693
|
|
694
694
|
|
695
|
-
##
|
695
|
+
## translations_exclude_collection
|
696
696
|
|
697
|
-
> AffectedCount
|
697
|
+
> AffectedCount translations_exclude_collection(project_id, translations_exclude_parameters, opts)
|
698
698
|
|
699
699
|
Set exclude from export flag on translations selected by query
|
700
700
|
|
@@ -725,10 +725,10 @@ opts = {
|
|
725
725
|
|
726
726
|
begin
|
727
727
|
#Set exclude from export flag on translations selected by query
|
728
|
-
result = api_instance.
|
728
|
+
result = api_instance.translations_exclude_collection(project_id, translations_exclude_parameters, opts)
|
729
729
|
pp result
|
730
730
|
rescue Phrase::ApiError => e
|
731
|
-
puts "Exception when calling TranslationsApi->
|
731
|
+
puts "Exception when calling TranslationsApi->translations_exclude_collection: #{e}"
|
732
732
|
end
|
733
733
|
```
|
734
734
|
|
@@ -755,9 +755,9 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
755
755
|
- **Accept**: application/json
|
756
756
|
|
757
757
|
|
758
|
-
##
|
758
|
+
## translations_include_collection
|
759
759
|
|
760
|
-
> AffectedCount
|
760
|
+
> AffectedCount translations_include_collection(project_id, translations_include_parameters, opts)
|
761
761
|
|
762
762
|
Remove exlude from import flag from translations selected by query
|
763
763
|
|
@@ -788,10 +788,10 @@ opts = {
|
|
788
788
|
|
789
789
|
begin
|
790
790
|
#Remove exlude from import flag from translations selected by query
|
791
|
-
result = api_instance.
|
791
|
+
result = api_instance.translations_include_collection(project_id, translations_include_parameters, opts)
|
792
792
|
pp result
|
793
793
|
rescue Phrase::ApiError => e
|
794
|
-
puts "Exception when calling TranslationsApi->
|
794
|
+
puts "Exception when calling TranslationsApi->translations_include_collection: #{e}"
|
795
795
|
end
|
796
796
|
```
|
797
797
|
|
@@ -891,9 +891,9 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
891
891
|
- **Accept**: application/json
|
892
892
|
|
893
893
|
|
894
|
-
##
|
894
|
+
## translations_review_collection
|
895
895
|
|
896
|
-
> AffectedCount
|
896
|
+
> AffectedCount translations_review_collection(project_id, translations_review_parameters, opts)
|
897
897
|
|
898
898
|
Review translations selected by query
|
899
899
|
|
@@ -924,10 +924,10 @@ opts = {
|
|
924
924
|
|
925
925
|
begin
|
926
926
|
#Review translations selected by query
|
927
|
-
result = api_instance.
|
927
|
+
result = api_instance.translations_review_collection(project_id, translations_review_parameters, opts)
|
928
928
|
pp result
|
929
929
|
rescue Phrase::ApiError => e
|
930
|
-
puts "Exception when calling TranslationsApi->
|
930
|
+
puts "Exception when calling TranslationsApi->translations_review_collection: #{e}"
|
931
931
|
end
|
932
932
|
```
|
933
933
|
|
@@ -1021,9 +1021,9 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
1021
1021
|
- **Accept**: application/json
|
1022
1022
|
|
1023
1023
|
|
1024
|
-
##
|
1024
|
+
## translations_unverify_collection
|
1025
1025
|
|
1026
|
-
> AffectedCount
|
1026
|
+
> AffectedCount translations_unverify_collection(project_id, translations_unverify_parameters, opts)
|
1027
1027
|
|
1028
1028
|
Mark translations selected by query as unverified
|
1029
1029
|
|
@@ -1054,10 +1054,10 @@ opts = {
|
|
1054
1054
|
|
1055
1055
|
begin
|
1056
1056
|
#Mark translations selected by query as unverified
|
1057
|
-
result = api_instance.
|
1057
|
+
result = api_instance.translations_unverify_collection(project_id, translations_unverify_parameters, opts)
|
1058
1058
|
pp result
|
1059
1059
|
rescue Phrase::ApiError => e
|
1060
|
-
puts "Exception when calling TranslationsApi->
|
1060
|
+
puts "Exception when calling TranslationsApi->translations_unverify_collection: #{e}"
|
1061
1061
|
end
|
1062
1062
|
```
|
1063
1063
|
|
@@ -1084,9 +1084,9 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
1084
1084
|
- **Accept**: application/json
|
1085
1085
|
|
1086
1086
|
|
1087
|
-
##
|
1087
|
+
## translations_verify_collection
|
1088
1088
|
|
1089
|
-
> AffectedCount
|
1089
|
+
> AffectedCount translations_verify_collection(project_id, translations_verify_parameters, opts)
|
1090
1090
|
|
1091
1091
|
Verify translations selected by query
|
1092
1092
|
|
@@ -1117,10 +1117,10 @@ opts = {
|
|
1117
1117
|
|
1118
1118
|
begin
|
1119
1119
|
#Verify translations selected by query
|
1120
|
-
result = api_instance.
|
1120
|
+
result = api_instance.translations_verify_collection(project_id, translations_verify_parameters, opts)
|
1121
1121
|
pp result
|
1122
1122
|
rescue Phrase::ApiError => e
|
1123
|
-
puts "Exception when calling TranslationsApi->
|
1123
|
+
puts "Exception when calling TranslationsApi->translations_verify_collection: #{e}"
|
1124
1124
|
end
|
1125
1125
|
```
|
1126
1126
|
|